Changelog

Date: Mar 8 2021

Commit: cfcd533

Added: vault/dendron.case-studies.md

Files changed (1) hide show

vault/dendron.case-studies.md +11 -0

vault/dendron.case-studies.md ADDED Viewed

@@ -0,0 +1,11 @@
+---
+id: 34ee4bcf-60e9-4031-a4c0-26113b5acb80
+title: Case Studies
+desc: ''
+updated: 1596566527331
+created: 1596566527331
+stub: false
+nav_order: 4.5
+---

Added: vault/dendron.case-studies.onboarding.md

Files changed (1) hide show

vault/dendron.case-studies.onboarding.md +14 -0

vault/dendron.case-studies.onboarding.md ADDED Viewed

@@ -0,0 +1,14 @@
+---
+id: e8d6241e-1708-4bde-bd3d-93b440a1eaad
+title: Dendron Onboarding
+desc: ''
+updated: 1598579955124
+created: 1598579955124
+stub: false
+---
+For new users, I do an initial [onboarding](https://calendly.com/thence/dendron) session to help folks get started.
+This is an example of an onboarding session.
+<iframe width="560" height="315" src="https://www.youtube.com/embed/3io2fHRmZsE" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

Added: vault/dendron.case-studies.para.md

Files changed (1) hide show

vault/dendron.case-studies.para.md +16 -0

vault/dendron.case-studies.para.md ADDED Viewed

@@ -0,0 +1,16 @@
+---
+id: 664c7980-f605-43ad-a931-c139740777c8
+title: PARA
+desc: ''
+updated: 1597286900059
+created: 1597286900059
+stub: false
+---
+PARA is a way of organizing all notes into four buckets. It's described [here](https://fortelabs.co/blog/para/).
+This is a video of how you might apply PARA inside Dendron.
+<a href="https://youtu.be/vrhBNGMJQwE">
+<img src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/usecase-para.jpg"/>
+</a>

Added: vault/dendron.cheatsheet.md

Files changed (1) hide show

vault/dendron.cheatsheet.md +312 -0

vault/dendron.cheatsheet.md ADDED Viewed

@@ -0,0 +1,312 @@
+---
+id: f9540bb6-7a5a-46db-ae7c-e1a606f28c73
+title: 'Cheatsheet'
+desc: ''
+updated: 1596374871110
+created: 1596374871110
+nav_order: 8.5
+---
+This is a cheatsheet for Dendron.
+# Useful Links
+- [Dendron Discord](https://discord.gg/6j85zNX): Get answers to all your questions here
+- [Dendron Onboarding](https://calendly.com/thence/dendron): If you are a new user, [Kevin](http://kevinslin.com/), our founder, does a personal onboarding to help you setup your workspace. You can see an example of said onboarding [here](https://www.dendron.so/notes/e8d6241e-1708-4bde-bd3d-93b440a1eaad.html).
+- [Github Issues](https://github.com/dendronhq/dendron/issues): If you found a bug or want to submit a feature request, you can file a ticket
+- [Hierarchal First Approach to Note Taking](https://www.kevinslin.com/notes/3dd58f62-fee5-4f93-b9f1-b0f0f59a9b64.html): An article about the principle that Dendron was built around
+- [VSCode Keyboard Shortcuts](https://code.visualstudio.com/docs/getstarted/keybindings#_keyboard-shortcuts-reference)
+# Commands
+---
+## Lookup
+### Dendron: Contribute
+- description: Become an environmentalist and keep Dendron sustainable
+- shortcuts: none
+---
+## Notes
+### Dendron: Create Daily Journal Note
+- description: Create a global journal note
+- shortcuts:
+  - key: `ctrl+shift+i`
+  - mac: `cmd+shift+i`
+  - when: `editorFocus`
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.daily.gif)
+### Dendron: Copy Note Link
+- description: Copy wiki link to note
+- shortcuts:
+  - key: `ctrl+shift+c`
+  - mac: `cmd+shift+c`
+  - when: `editorFocus`
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command.copy-link.gif)
+### Dendron: Copy Note Ref
+- description: Copies a reference to the current open document
+- shortcuts:
+  - key: `ctrl+shift+r`
+  - mac: `cmd+shift+r`
+  - when: `editorFocus`
+### Dendron: Delete Node
+- description: Delete a note or schema
+- shortcuts:
+  - key: `ctrl+shift+d`
+  - mac: `cmd+shift+d`
+### Dendron: Rename Note
+- description: Rename a note and all backlinks
+- shortcuts: none
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command-rename.gif)
+### Dendron: Show Preview
+- description: Show Markdown Preview
+- shortcuts:
+  - windows: `windows+ctrl+p`
+  - mac: `cmd+ctrl+p`
+---
+## Navigation
+### Dendron: Lookup
+- description: Initiate note lookup
+- shortcuts:
+  - mac: `cmd+L`
+  - key: `ctrl+l`
+### Dendron: Lookup (Journal Note)
+- description: Initiate note lookup with journal note pre-selected
+- shortcuts:
+  - key: `ctrl+shift+j`
+  - mac: `cmd+shift+j`
+  - args: `{'noteType': 'journal'}`
+### Dendron: Lookup (Scratch Note)
+- description: Initiate note lookup with scratch note pre-selected
+- shortcuts:
+  - key: `ctrl+shift+s`
+  - mac: `cmd+shift+s`
+  - args: `{'noteType': 'scratch', 'selectionType': 'selection2link'}`
+### Dendron: Lookup Schema
+- description: Initiate schema lookup
+- shortcuts:
+  - mac: `cmd+shift+L`
+  - key: `ctrl+shift+l`
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-lookup.gif)
+### Dendron: Open Link
+- description: Open link to external file (eg. pdf, .mov, etc) use system default
+- shortcuts: none
+<a href="https://www.loom.com/share/01250485e20a4cdca2a053dd6047ac68"><img src="https://cdn.loom.com/sessions/thumbnails/01250485e20a4cdca2a053dd6047ac68-with-play.gif"> </a>
+---
+## Hierarchies
+### Dendron: Reload Index
+- description: Reload the index. Necessary for Dendron to pick up on schema changes.
+- shortcuts: none
+### Dendron: Archive Hierarchy
+- description: Move current note and all children under the `archive` hierarchy
+- shortcuts: none
+<a href="https://www.loom.com/share/9698d5a4451b49d8b107f3ff67d97877">  <img style="" src="https://cdn.loom.com/sessions/thumbnails/9698d5a4451b49d8b107f3ff67d97877-with-play.gif"> </a>
+### Dendron: Refactor Hierarchy
+- description: Update hierarchy using regex
+- shortcuts: none
+<a href="https://www.loom.com/share/11d90a86fd1348a5a504406b52d79f85"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/11d90a86fd1348a5a504406b52d79f85-with-play.gif"> </a>
+### Dendron: Go Up
+- description: Go to closet non-stub parent of the currently open note
+- shortcuts:
+  - mac: `cmd+shift+up`
+  - key: `ctrl+shift+up`
+  - when: `editorFocus`
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-up.gif)
+### Dendron: Go Next Sibling
+- description: Go to the next sibling
+- shortcuts:
+  - key: `ctrl+shift+]`
+  - when: `editorFocus`
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-sibling.gif)
+### Dendron: Go Previous Sibling
+- description: Go to the previous sibling
+- shortcuts:
+  - key: `ctrl+shift+[`
+  - when: `editorFocus`
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-sibling.gif)
+### Dendron: Go Down
+- description: Go down the hierarchy
+- shortcuts:
+  - mac: `cmd+shift+down`
+  - key: `ctrl+shift+down`
+  - when: `editorFocus`
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-down.gif)
+---
+## Workspace
+### Dendron: Vault Add
+- description: Add a new vault
+- shortcuts: none
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/b4171372f9794dd7be609c043f343fa3" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+### Dendron: Vault Remove
+- description: Remove a vault
+- shortcuts: none
+Remove a vault from your workspace. Note that the underlying files wil **not** be deleted - the vault will lose its association with your workspace.
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/307effc22b8d4c59a32933529a8393e1" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+### Dendron: Initialize Workspace
+- description: Create a new workspace
+- shortcuts: none
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workspace-init.gif)
+### Dendron: Change Workspace
+- description: Change into existing workspace
+- shortcuts: none
+### Dendron: Snapshot Vault
+- description: Create a snapshot of your vault
+- shortcuts: none
+### Dendron: Restore Vault
+- description: Restore your vault from a snapshot
+- shortcuts: none
+### Dendron: Show Help
+- description: Dendron will open your current browser to the [[cheatsheet|dendron.cheatsheet]] page.
+- shortcuts: none
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.help.gif)
+### Dendron: Configure (yaml)
+- description: Modify Dendron Config as raw YAML
+- shortcuts: none
+### Dendron: Configure
+- description: Modify Dendron Config using Dendron UI
+- shortcuts: none
+---
+## Pods
+### Dendron: Build Pod
+- description: Build your notes for export. Currently, only export to github pages is supported.
+- shortcuts: none
+### Dendron: Configure Pod
+- description: Update your pod configuration
+- shortcuts: none
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pods.configure.gif)
+### Dendron: Import Pod
+- description: Import notes from an external data source. Currently, only the local file system is supported
+- shortcuts: none
+### Dendron: Export Pod
+- description: Export notes to an external data source. Currently only JSON is supported.
+- shortcuts: none
+<a href="https://www.loom.com/share/d49e5f4155af485cadc9cd810b6cab28"> <img src="https://cdn.loom.com/sessions/thumbnails/d49e5f4155af485cadc9cd810b6cab28-with-play.gif"> </a>
+### Dendron: Publish Pod
+- description: Publish your note to a different format/location
+- shortcuts: none
+### Dendron: Copy Note URL
+- description: Get URL of current note from published site
+- shortcuts:
+  - mac: `cmd+shift+u`
+  - windows: `ctrl+shift+u`
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.copy-url.gif)
+---
+## Publishing
+### Dendron: Publish
+- description: Build, commit and publish your notes with a single command
+- shortcuts: none
+<a href="https://www.loom.com/share/c58edf543e234a8fa164095237579ccc"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/c58edf543e234a8fa164095237579ccc-with-play.gif"> </a>
+### Dendron: Site Build
+- description: Build your notes using publishing v2
+- shortcuts: none
+### Dendron: Site Preview
+- description: Preview your notes on localhost using publishing v2
+- shortcuts: none
+---
+## Dev
+### Dendron: Doctor
+- description: Auto fix issues with frontmatter
+- shortcuts: none
+<a href="https://www.loom.com/share/bd045f708f8e474193de8e3de0dc820f"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/bd045f708f8e474193de8e3de0dc820f-with-play.gif"> </a>
+### Dendron: Dump State
+- description: Dump internal state of Dendron inside logs
+- shortcuts: none
+### Dendron:Dev: Open Logs
+- description: Open Dendron logs for current session
+- shortcuts: none

Added: vault/dendron.community.md

Files changed (1) hide show

vault/dendron.community.md +10 -0

vault/dendron.community.md ADDED Viewed

@@ -0,0 +1,10 @@
+---
+id: 6f4cd441-f883-4e75-871b-b7f93895c91b
+title: Community
+desc: ''
+updated: 1607965800209
+created: 1604236612582
+nav_order: 2.2
+---
+Dendron wouldn't be what it is today without its wonderful users.

Added: vault/dendron.community.roles.md

Files changed (1) hide show

vault/dendron.community.roles.md +38 -0

vault/dendron.community.roles.md ADDED Viewed

@@ -0,0 +1,38 @@
+---
+id: 7c00d606-7b75-4d28-b563-d75f33f8e0d7
+title: Roles
+desc: ''
+updated: 1605552659231
+created: 1604237102230
+---
+Dendron has special roles for members of its community.
+## Dendrologist
+**Dendrologist** are active members of the Dendron community. They play a vital role in helping new members get started and setting best practices for Dendron and its community.
+Dendrologist help shape Dendron's roadmap and community standards. They also gain additional discord super powers like creating channels, pinning messages, and other moderation capabilities.
+## Environmentalist
+**Environmentalist** are members that show their support by making monthly [financial contributions](https://accounts.dendron.so/account/subscribe) to Dendron.
+Environmentalist get a special discord role, early access to new features,
+special channels, and other goodies.
+## Horticulturalist
+**Horticulturalist** are members who have contributed to the Dendron code base.
+## Taxonomist
+A **Taxonomist** is a member who improved the Dendron documentation.
+## Planter
+A **Planter** is a member who published their notes using Dendron
+## Bug Catcher
+A **Bug Catcher** is a member who found a reproducible bug in Dendron.

Added: vault/dendron.community.showcase.md

Files changed (1) hide show

vault/dendron.community.showcase.md +78 -0

vault/dendron.community.showcase.md ADDED Viewed

@@ -0,0 +1,78 @@
+---
+id: 3a82c5ff-7945-46ae-8bf9-3b2275fc6642
+title: Showcase
+desc: ''
+updated: 1614059886015
+created: 1600010740851
+---
+Below are examples of published Dendron vaults
+## Official
+### Dendron homepage
+- homepage: <https://dendron.so>
+  ![](/assets/images/2020-09-13-09-05-45.png)
+### Open PKM Catalogue
+- homepage: <https://pkm.dendron.so>
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/showcase.pkm.jpg)
+### Open AWS Catalogue
+- homepage: <https://aws.dendron.so>
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/showcase.aws.jpg)
+## Members
+### Kevin's page
+- homepage: <https://kevinslin.com/>
+- discord: `@kevins8#0590`
+  ![](/assets/images/2020-09-13-08-45-00.png)
+### Ed's Page
+- homepage: <https://ens100.github.io/>
+- discord: `@edns100#4851`
+![](/assets/images/2020-09-13-09-04-36.png)
+### Jack's page
+- homepage: <https://imalightbulb.xyz>
+- discord: `@I'm a lightbulb#6986`
+![](/assets/images/2020-09-13-09-01-48.png)
+### Luke's second brain
+- homepage: <https://luke.carrier.im/>
+- discord: `@lukecarrier#2081`
+![](/assets/images/2020-09-27-20-50-54.png)
+### Ian's digital garden
+- homepage: <https://garden.ianjones.us/>
+- discord: `@ianjones#3696`
+![](/assets/images/2020-12-06-09-43-31.png)
+### Kevin's digital garden (another one)
+- homepage: garden.kevincunningham.co.uk
+- discord: `@dolearning (Kevin)#3551`
+![ScreenShot of @dolearning digital garden](https://res.cloudinary.com/kc-cloud/image/upload/v1607614868/digital_garden_screenshot_j9wrcz.png)
+### Cameron's digital garden
+- homepage: <https://notes.serendipidata.com/>
+- discord: `@cameron#9185`
+![](https://p-qkfgo2.t2.n0.cdn.getcloudapp.com/items/WnuBJ0L1/8befb6dd-740d-4088-bbeb-b5c21954e308.jpg?v=4e54f3d2ffbbe051c195eab04c72971f)

Added: vault/dendron.concepts.md

Files changed (1) hide show

vault/dendron.concepts.md +136 -0

vault/dendron.concepts.md ADDED Viewed

@@ -0,0 +1,136 @@
+---
+id: c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50
+title: Concepts
+desc: ''
+updated: 1614057298609
+created: 1595169512265
+nav_order: 3
+---
+Below are some concepts that are helpful to know when using Dendron. Note that features with 🚧 are still under active development and might not be fully implemented.
+### Markdown
+Dendron supports markdown, a popular markup syntax that is like HTML but 1000x simpler. If you are new to markdown, you can read about the syntax [here](https://docs.gitbook.com/editing-content/markdown).
+### Frontmatter
+Frontmatter is a convenient way of adding extra information to your documents like a shorthand title or longer description (think any extra information you can use to describe a note). This type of information is generally called metadata and the structure used is called [YAML](https://yaml.org/). You can add it to the front of your markdown file and it won't show up in the preview. It was first introduced by [jekyll](https://jekyllrb.com/docs/front-matter/).
+You can read more about the frontmatter used in Dendron [[here |dendron.topic.frontmatter]]
+### Workspace
+In Dendron, your **workspace** is the root of where all your files are located. It's set when you first run `Dendron: Initialize Workspace`. The folder that contains your workspace is also known as your **workspace root**.
+### Vaults
+Your workspace is made up of **vaults**. A dendron vault stores a collection of related notes. If you're familiar with git, it's just like a code repo. By default, Dendron creates a *vaults* folder when you first initialize a **workspace**. All your notes are stored on a per vault basis.
+```
+.
+└── workspace
+    ├── vault.main
+    │   ├── foo.md
+    │   ├── foo.one.md
+    │   └── foo.two.md
+    └── vault.secret (hypothetical)
+        ├── secret.one.md
+        └── secret.two.md
+```
+By default, when you look for notes in Dendron, it will search over all vaults.
+A vault can be one of two types:
+- local
+- remote
+#### Local Vault
+A local vault is what you start off with. Its a vault that is local to your file system.
+#### Remote Vault
+A remote vault is what you get when you run the [[Vault Add|dendron.topic.commands#vault-add]] command and select a remote vault. This is a vault that is cloned from a git repo.
+<!--
+### Workspace Configuration
+Workspace configuration is located directly underneath the **workspace root**.  By convention, the default configuration is going to be in a folder titled **config**. This is also called the **configuration root**. A workspace can have multiple configurations that initializes your workspace with a different subset of vaults.
+-->
+### Hierarchies
+((ref:[[dendron.topic.hierarchies]]#Hierarchies,1:#Concepts))
+You can read more about hierarchies [[here|dendron.topic.hierarchies]]
+### Domain
+A domain is the root of a hierarchy. In the example below, `project1` would be the domain.
+```
+.
+├── project1.md
+├── project1.designs.md
+├── project1.designs.promotion.md
+├── project1.paperwork.md
+├── project1.paperwork.legal.md
+├── project1.tasks.md
+├── project1.tasks.task1.md
+└── project1.tasks.task2.md
+```
+### Schema
+As you end up creating more notes, it can be hard to keep track of it all. This is why Dendron has **schemas** to help you manage your notes. Think of schemas as an **optional type system** for your information. They describe the hierarchy of your notes and are themselves, represented as a hierarchy.
+You can create a schema by adding a YAML file with the following naming scheme `{name}.schema.yml` to your workspace.
+Below is an example of a three-level hierarchy describing cli commands. You don't need to concern yourself with the details of the schema syntax just yet, just know that this schema will match the following [glob patterns](https://facelessuser.github.io/wcmatch/glob/): `cli.*`, `cli.*.cmd`, `cli.*.cmd.*`, `cli.*.env`
+```yml
+- id: cli
+  desc: command line interface reference
+  parent: root
+  namespace: true
+  children cmd
+    - env
+- id: env
+  desc: variables relevant for command
+- id: cmd
+  desc: subcommands
+  namespace: true
+```
+### Stubs
+Stubs are notes that don't exist but that you might want to create. They will show up as suggestions in lookup results.
+There are two reasons why these suggested notes might show up:
+- they are the uncreated parent of a note deeper in the hierarchy (eg. `foo.bar` might be a stub for `foo.bar.foobar`)
+- they are possible notes according to the schema
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-plus.jpg)
+> The `+` sign next to the suggestion indicates that the note is a stub and does not exist
+### Pods
+[[Pods |dendron.topic.pod]] are the mechanisms Dendron uses to import and export notes. Dendron has a different pod depending on where you are getting and publishing your data to.
+### Command Bar
+The command bar is native to `vscode`. You can use it to run dendron commands, which will all be prefixed with `Dendron:`. You can use the following shortcut to open the command bar.
+- <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf">Linux</a> `Ctrl+Shift+P`
+- <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf">macOS</a> `Cmd+Shift+P`
+- <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf">Windows</a> `Ctrl+Shift+P`
+### Lookup Bar
+The lookup bar is how you interact with notes inside of Dendron. Use it to create, find, and delete notes. You can type `> Dendron: Lookup` in the `Command Bar` or use the `Ctrl+L` shortcut.
+- <img src="https://www.kernel.org/theme/images/logos/favicon.png" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-linux.pdf">Linux</a> `Ctrl+L`
+- <img src="https://developer.apple.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-macos.pdf">macOS</a> `Cmd+L`
+- <img src="https://www.microsoft.com/favicon.ico" width=16 height=16/> <a href="https://code.visualstudio.com/shortcuts/keyboard-shortcuts-windows.pdf">Windows</a> `Ctrl+L`
+![](assets/2020-07-07-20-14-57.png)

Added: vault/dendron.contribute.dev.md

Files changed (1) hide show

vault/dendron.contribute.dev.md +50 -0

vault/dendron.contribute.dev.md ADDED Viewed

@@ -0,0 +1,50 @@
+---
+id: 81da87be-2d4e-47b5-a1d6-c0d647e1ab00
+title: Development
+desc: ''
+updated: 1614811289748
+created: 1604236041570
+---
+## Summary
+If you would like to contribute to the development of dendron, checkout out the [repo](https://github.com/dendronhq/dendron) from github.
+You can then follow the [[setup instructions|dendron.dev.setup#getting-started]].
+- NOTE: the above setup instructions are for the dendron plugin. See the below links if you are working on a different part of Dendron:
+    - [[Markdown Preview|dendron.pro.dendron-preview.setup]]
+    - [[Markdown Links|dendron.pro.markdown-links.setup]]
+A great place to start is with issues labelled with the [size.small label](https://github.com/dendronhq/dendron/labels/size.small) on github. These are items that we picked out specifically for first time contributors and are small self contained task that are well suited for first time contributors.
+Leave a comment in the issue if you decide to work on it. Issues that are being worked on will have the [status.wip label](https://github.com/dendronhq/dendron/labels/status.wip).
+Remember that you are always welcome to ask for help inside the [#dev discord channel](https://discord.gg/AE3NRw9).
+![[dendron.journal.2021.02.20.migration]]
+## VSCode Extension Development
+If you're not familiar with VSCode Extension Development, have no fear. There are lots of great resources for that.
+The VSCode guide to [making your first extension](https://code.visualstudio.com/api/get-started/your-first-extension) is a great place to start.
+Afterwards, you can see how specific features are implemented through the [vscode extension samples library](https://github.com/microsoft/vscode-extension-samples).
+## Pull Request Checklist
+- [ ] add a [[test|dendron.dev.testing#writing-tests]] for the new feature
+- [ ] make sure all the existing [[tests|dendron.dev.testing#running-all-tests]] pass
+- [ ] if its your first pull request to Dendron, watch out for the [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement) bot that will ask you to agree to Dendron's CLA
+- [ ] if its your first pull request and you're on our Discord, make sure that Kevin gives you the [[horticulturalist|dendron.community.roles#horticulturalist]] role  👨‍🌾👩‍🌾
+## Commit Style
+- we follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) with the following tags
+- categories:
+    - feat: feature - introduce new functionality
+    - enhance: enhancement - improve existing functionality
+    - fix: make something not broken
+    - chore: backend improvements
+    - spike: not complete commit

Added: vault/dendron.contribute.documentation.md

Files changed (1) hide show

vault/dendron.contribute.documentation.md +30 -0

vault/dendron.contribute.documentation.md ADDED Viewed

@@ -0,0 +1,30 @@
+---
+id: b58801fc-43a9-4d42-a58b-eabc3e8538cb
+title: Documentation
+desc: ''
+updated: 1612846119097
+created: 1604235766390
+---
+## Summary
+If you would like to contribute to the docs, you can do so by either making changes on github directly or by cloning our website repo and sending us a pull request.
+### Making Changes on Github
+Click `Edit this page on github` at the bottom left corner of every page. This is recommended way of making a change. The only pre-requisite is that you have a [github](https://github.com/) account.
+    <a href="https://www.loom.com/share/4a1b67f3fd1a40dab16949e9ea5e53dc"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/4a1b67f3fd1a40dab16949e9ea5e53dc-with-play.gif"> </a>
+Images
+- if you're adding an image along with the documentation, you can [imgur](https://imgur.com/upload) to upload
+- note that you'll want to copy the **image link** and not the link to the imgur website
+<a href="https://www.loom.com/share/1b351d229eba4536a6361e5123cf8f24">  <img style="" src="https://cdn.loom.com/sessions/thumbnails/1b351d229eba4536a6361e5123cf8f24-with-play.gif"> </a>
+Gifs
+- uploading gifs is the same process as uploading images
+- to create gifs, we recommend using the [Kap](https://getkap.co/) app or making a [Loom video](http://loom.com/)
+- if you are making a gif from within vscode, please turn on [screencast mode](https://scotch.io/bar-talk/vs-code-screencast-mode) so we can see what awesome keyboard shortcuts you're using :)
+### Making Changes via Pull Request
+For more involved changes, you can clone our github [repo](https://github.com/dendronhq/dendron-template) and opening `dendron.code-workspace` using VSCode.  [Dendron.so](https://www.dendron.so) is built from the contents of `vault/dendron.*`. Make a change in the corresponding file and send us a pull request to update the documentation. You can preview your changes using the `Dendron Markdown Enhanced` extension.

Added: vault/dendron.contribute.financial.md

Files changed (1) hide show

vault/dendron.contribute.financial.md +15 -0

vault/dendron.contribute.financial.md ADDED Viewed

@@ -0,0 +1,15 @@
+---
+id: abda4d2a-d8a2-4dd6-8ea0-4a5661fa13c1
+title: Financial
+desc: ''
+updated: 1604236474623
+created: 1604236189356
+---
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/grow-covid-2.png)
+If you would like to make a financial contribution to Dendron, you can do so by getting a Dendron **environmentalist** subscription.
+Environmentalists are special members of our community that help to keep Dendron sustainable. They get access to early builds, priority support, and access to our dev channel.
+You can sign up to be an environmentalist [here](https://accounts.dendron.so/account/subscribe).

Added: vault/dendron.contribute.first-dev.md

Files changed (1) hide show

vault/dendron.contribute.first-dev.md +20 -0

vault/dendron.contribute.first-dev.md ADDED Viewed

@@ -0,0 +1,20 @@
+---
+id: 70b4a93a-c7e0-4e1c-a873-3a9a291f5248
+title: First Time Developers
+desc: ''
+updated: 1605761135508
+created: 1605760540330
+---
+If you are interested in contributing to Dendron but haven't spent your career doing software, worry not. This is definitely something you can 🌱 into.
+We have lots of resources to help you make your first contribution.
+If you are completely new to software development, I would encourage you to look at the following resources:
+- primer to typescript (everything in Dendron is based on this): <https://www.typescriptlang.org/docs/handbook/typescript-from-scratch.html>
+- go through the javascript course: <https://www.codecademy.com/learn/introduction-to-javascript>
+When you are ready to make a contribution, you can follow the instructions in the [[development page|dendron.contribute.dev]]
+I'm also planning on streaming some dendron development on twitch in the coming weeks to show my workflow for working with Dendron and will give you a heads up when I'm doing them.

Added: vault/dendron.contribute.md

Files changed (1) hide show

vault/dendron.contribute.md +29 -0

vault/dendron.contribute.md ADDED Viewed

@@ -0,0 +1,29 @@
+---
+id: 125c990b-6fe7-4ada-a65f-44cbde8b33f0
+title: Contribute
+desc: ''
+updated: 1612846152764
+created: 1596817278150
+stub: false
+nav_order: 9.5
+toc: true
+---
+## Table of Contents
+## Development
+![[dendron.contribute.dev#summary,1:#*]]
+### First Time Developers
+![[dendron.contribute.first-dev]]
+## Documentation
+![[dendron.contribute.documentation#summary,1:#*]]
+## Financially
+![[dendron.contribute.financial]]

Added: vault/dendron.dev.api.md

Files changed (1) hide show

vault/dendron.dev.api.md +10 -0

vault/dendron.dev.api.md ADDED Viewed

@@ -0,0 +1,10 @@
+---
+id: 348fc5c7-e1ba-4fa2-ab6d-a3c94628fa11
+title: API
+desc: ''
+updated: 1600376820065
+created: 1600376820065
+stub: false
+---

Added: vault/dendron.dev.api.seeds.md

Files changed (1) hide show

vault/dendron.dev.api.seeds.md +16 -0

vault/dendron.dev.api.seeds.md ADDED Viewed

@@ -0,0 +1,16 @@
+---
+id: 08a917a9-31f1-434d-bc7f-71dce2b63a27
+title: Seeds
+desc: ''
+updated: 1600376826105
+created: 1600376826105
+stub: false
+---
+((ref:[[dendron.topic.seeds]]#seeds 🚧,1:#*))
+# DendronSeed
+Base class to extend from when creating a new seed. Documentation is still under construction. In the meanwhile, you can use [the code](https://github.com/dendronhq/dendron/blob/master/packages/seeds-core/src/base.ts#L39) as a guide when creating a new seed.
+You can see an example of a seed implementation [here](https://github.com/dendronhq/seeds.aws/blob/master/packages/awsgeek-seed/src/index.ts#L63:L63)

Added: vault/dendron.dev.cook.md

Files changed (1) hide show

vault/dendron.dev.cook.md +72 -0

vault/dendron.dev.cook.md ADDED Viewed

@@ -0,0 +1,72 @@
+---
+id: a80f36d9-01d0-4c5a-a228-867b093a4913
+title: Cookbook
+desc: ''
+updated: 1614811373375
+created: 1599151918645
+stub: false
+---
+### Install a new package
+Because Dendron is packaged as a mono repo managed using [lerna](https://github.com/lerna/lerna), you can't just do a regular `yarn add` to install new packages. This is because lerna symlinks mono-repo dependencies together and a `yarn add` would override that. Instead, use the following command:
+```
+lerna add {package-to-install} --scope @dendronhq/{package-to-install-into}
+```
+Because this is typescript, don't forget to also install the `@types` package if it exists
+```bash
+lerna add @types/{package-to-install} --scope @dendronhq/{package-to-install-into}
+```
+### Add a new node package
+- initialize repo
+```bash
+cd {workspace_dir}
+cp -R /path/to/dendron-yeoman/node-ts packages/{new-package}
+```
+- update `package.json`
+  - change project name
+- publish the repo (needs to be done initially before running lerna publish)
+```
+npm publish --access public
+```
+### Using eslint
+All packages in the repo use a standard base configuration found at [.eslintrc.js](.eslintrc.js). If you're using the VS Code and would like to see eslint violations on it, install the [eslint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
+### Add a new site config option
+The following is an example of controlling formatting options to the DendronSiteConfig. You can see the [issue](https://github.com/dendronhq/dendron/issues/278) for more details.
+Dendron currently will auto-format notes during `Rename` and `Refactor` operations when links inside a note need to be replaced.
+The formatting options are defined [here](https://dendron.so/notes/849ee8ee-05a5-47bf-b44d-d7c257117bc4.html#renaming-a-note).
+These are [rough notes](https://dendron.so/notes/849ee8ee-05a5-47bf-b44d-d7c257117bc4.html#flow) of how formatting gets called during rename
+To make this customizable, the following changes need to be made:
+- [ ] update the [DendronConfig type definition](https://github.com/dendronhq/dendron/blob/master/packages/common-all/src/types.ts#L405:L405)
+- [ ] update [config defaults](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/config.ts#L42:L42)
+- [ ] pass in formatting options from the [plugin](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/commands/RenameNoteV2a.ts#L137:L137)
+- [ ] accept formatting args in the [server](https://github.com/dendronhq/dendron/blob/master/packages/api-server/src/routes/note.ts#L38:L38)
+- [ ] accept formatting args in the [engine](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/enginev2.ts#L249:L249)
+- [ ] accept it when [replacing links](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/topics/markdown/utilsv2.ts#L85:L85)
+- [ ] accept it in [remark pipeline](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/topics/markdown/utilsv2.ts#L41:L41)
+When all this is done, we can add tests that the formatting behavior works
+- [ ] [engine tests](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/__tests__/enginev2.spec.ts#L652:L652)
+- [ ] [plugin test](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/test/suite-integ/RenameNoteV2.test.ts#L157:L157)
+The above changes are for `Rename`. `Refactor` calls rename in a loop so changing rename should update refactor as well.

Added: vault/dendron.dev.debug.md

Files changed (1) hide show

vault/dendron.dev.debug.md +53 -0

vault/dendron.dev.debug.md ADDED Viewed

@@ -0,0 +1,53 @@
+---
+id: b239c77e-52f2-4cc3-8390-69e0bc776a72
+title: Debugging
+desc: ''
+updated: 1607366232319
+created: 1598653859135
+stub: false
+---
+## Plugin
+- run extension
+  - launch the `Run Extnesion` build task (copied below for reference)
+```json
+    {
+      "name": "Run Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "--disable-extensions",
+        "--extensionDevelopmentPath=${workspaceFolder}"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/out/**/*.js"
+      ],
+      "env": {
+        "STAGE": "dev",
+        "VSCODE_DEBUGGING_EXTENSION": "dendron"
+      }
+    },
+```
+### Breakpoints
+Note that we currently have trouble setting breakpoints inside non-plugin code. That goes for the packages that Dendron depends on (eg. @dendronhq/common-all). The current workaround is to manually add a `debugger;` statement inside the code. The extension will hit it when restarted under the debugger.
+### Verbose Logs
+- set in `dendorn.workspace.config`
+```json
+"dendron.logLevel": "debug",
+```
+## Server
+Normally, Dendron will launch an express server at a random port. To debug the server:
+1. Launch the server using the build task `api-server:test launch server`
+2. Update the workspace settings of Dendron to use a running server through the following workspace setting `dendron.serverPort": 3005`
+3. Reload the workspace for the settings to take affect

Added: vault/dendron.dev.design.commands.md

Files changed (1) hide show

vault/dendron.dev.design.commands.md +9 -0

vault/dendron.dev.design.commands.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: fc73e5c7-d0fa-43d3-9c45-943c67d8afdb
+title: Commands
+desc: ''
+updated: 1603668197282
+created: 1599360021856
+stub: false
+---

Added: vault/dendron.dev.design.commands.rename.md

Files changed (1) hide show

vault/dendron.dev.design.commands.rename.md +31 -0

vault/dendron.dev.design.commands.rename.md ADDED Viewed

@@ -0,0 +1,31 @@
+---
+id: 9bcb030d-3e8e-4173-85fb-846b3c3bc83a
+title: Rename
+desc: ''
+updated: 1606863442772
+created: 1598917863248
+stub: false
+---
+## Summary
+## Flows
+- loc: plugin-core/src/commands/RenameNoteV2.ts
+```ts
+...
+allUris = getWorkspaceCache.allUris + files.map{ f => f.newUri }
+newUris = allUris
+```
+-
+```ts
+getWorkspaceCache {
+}
+cacheUris {
+    markdownUris = DendronWorkspace.instance().engine.notes
+}
+```

Added: vault/dendron.dev.design.engine.md

Files changed (1) hide show

vault/dendron.dev.design.engine.md +359 -0

vault/dendron.dev.design.engine.md ADDED Viewed

@@ -0,0 +1,359 @@
+---
+id: 849ee8ee-05a5-47bf-b44d-d7c257117bc4
+title: Summary
+desc: ''
+updated: 1605287509430
+created: 1598652399447
+stub: false
+---
+These documents are a high level overview of the code inside Dendron. They are written in a type script like pseudo code. The code blocks are broken down into the following structure:
+```
+# {Function}  --> what is happening
+## Summary    --> high level function call of what is happening
+## Flows      --> pseudo code describing high level functions
+### {Flow Entry}
+- loc: ... --> where code is located. {package}/{basename}
+- desc: ... --> description
+```
+## Pseudo Code
+The code description is typescript-ish. The goal isn't to write valid typescript but be a **summarized** version of the code. The syntax is evolving but here is a loosely documented starting point:
+- @: equivalent of `this.`
+- $: referencing a global variable
+- `...`: code that is omitted because it would clutter the summary
+- `=:` magic equality,
+The places where you see this convention being broken (eg. actual valid typescript) are areas where the author got lazy and just copied code into the summary. Try to not do this because that defeats the point of a _summarized_ view. That being said, Dendron is all about being pragmatic and taking an iterative approach to things.
+# Initializing the Engine
+## Summary
+- engine.query
+  - store.query
+    - FileParser.parse
+      ```ts
+      allFiles {
+        getFileMeta
+        toNode
+      }
+      ```
+    - NodeBuilder.buildNoteFromProps
+      ```ts
+      {
+        root, childrenIds = getRoot
+        nodes = [root]
+        while nodes {
+          toNote it
+        }
+      }
+      ```
+## Flow
+### Initialize the engine
+- loc: engine-server/engine.ts
+- desc: initial query to index all notes
+```ts
+init {
+  @query("**/*", "schema", {
+    fullNode: false,
+    initialQuery: true,
+  });
+  @query("**/*", "note", {
+    fullNode: false,
+    initialQuery: true,
+  });
+}
+```
+### Query - Engine
+- loc: engine-server/engine.ts
+- desc: engine will query the store
+```ts
+async query(scope: Scope, queryString: string, opts?: QueryOpts) {
+  opts = _.defaults(opts || {}, {
+    fullNode: false
+  });
+  if (queryString === '**/*') {
+    const data = await this.store.query(scope, '**/*', opts);
+    this.refreshNodes(data.data);
+  }
+}
+```
+### Query - Store
+- loc: engine-server/store.ts
+  - FileStore.query
+- desc: store is swappable. currently, we only support `FileStore`
+```ts
+  if (@isQueryAll(queryString)) {
+      noteProps = @_getNoteAll() {
+          allFiles = getAllFiles({
+              root: this.opts.root,
+              include: ["*.md"]
+          })
+          return @files2Notes(allfiles) {
+              fp = new FileParser({ errorOnEmpty: false })
+              data = fp.parse(allFiles);
+              return data.map(n => n.toRawProps());
+          }
+      }
+      const data = new NodeBuilder().buildNoteFromProps(noteProps);
+  }
+```
+#### Parse Files
+- loc: engine-server/parser.ts
+- details: read files
+```ts
+parse(data: string[]): Note[] {
+    fileMetaDict: FileMetaDict = getFileMeta(data) {
+      metaDict: FileMetaDict = {};
+      _.forEach(fpaths, fpath => {
+        { name } = path.parse(fpath);
+        lvl = name.split(".").length;
+        if (!_.has(metaDict, lvl)) {
+          metaDict[lvl] = [];
+        }
+        metaDict[lvl].push({ prefix: name, fpath });
+      });
+      return metaDict;
+    }
+    ...
+    root = fileMetaDict[1].find(n => n.fpath === "root.md") as FileMeta;
+    const { node: rootNode } = this.toNode(root, [], store, {
+      isRoot: true,
+      errorOnBadParse: this.opts.errorOnBadParse
+    }) as { node: Note };
+    ...
+    while (_.has(fileMetaDict, lvl)) {
+        ...
+        const { node, missing } = this.toNode(ent, prevNodes, store, {})
+    }
+}
+toNode {
+    noteProps = mdFile2NodeProps(path.join(store.opts.root, ent.fpath)) {
+        const { data, content: body } = (matter.read(fpath, {}) as unknown) as {
+        const { name: fname } = path.parse(fpath);
+        const dataProps = DNodeRaw.createProps({ ...data, fname, body });
+    }
+    // missing
+    if (!parent && !opts.isRoot) {
+      missing = parentPath;
+      if (opts.errorOnEmpty) {
+        throw new Error(JSON.stringify(errorMsg));
+      }
+    }
+    const note = new Note({ ...noteProps, parent, children: [] });
+}
+```
+#### Build Nodes
+- loc: src/node.ts
+```ts
+buildNoteFromProps(nodes) {
+    // initialize root
+    out = []
+    root, childrenIds = getRoot nodes {
+        if root not in nodes
+            throw DendronError // this gets caught in the engine
+        return root
+    }
+    out.push root
+    parentNodes = [root]
+    nodeIds = childrenIds
+    while nodeIds {
+      nodeIds.map {
+        nodeProps = nodes.find it.id
+        @toNote nodeProps, parentNodes
+      }
+    }
+}
+toNote {
+  note = new Note(..., children: [], parent: null)
+  parent = find(parents)
+  parent.addChild note
+  ret
+}
+```
+# New Node
+## Flow
+- loc: engine-server/engine.ts
+```ts
+write(node){
+  @store.write
+  @updateNodes node
+}
+```
+# Updating a Node
+## Summary
+## Flow
+- loc: engine-server/engine.ts
+```ts
+updateNodes(nodes) {
+  if node.type == 'schema' {
+    ...
+  } else {
+    @_updateNote(nodes)
+  }
+}
+_updateNote(nodes, opts) {
+  addParent(nodes) if !opts.noAddParent
+  @refreshNodes
+}
+```
+# Deleting a Node
+## Summary
+## Flow
+- loc: engine-server/engine.ts
+```ts
+delete(idOrFname, mode, opts) {
+  if (mode == 'note') {
+    noteToDelete := @notes
+  } else {
+    // schemas
+    ...
+  }
+  // delete from store
+  if !opts.metaOnly {
+    @store.delete(noteToDelete)
+  }
+  // remove from index
+  @deleteFromNodes noteToDelete
+  // if node has children , keep it in index as a stub
+  if noteToDelete.children {
+    noteToDelete.stub = true
+    @refreshNotes noteToDelete
+  } else {
+    // remove node from parent
+    noteToDelete.parent.children.reject { noteToDelete } if noteToDelete.parent
+  }
+}
+```
+# Parsing note references
+((ref:[[dendron.topic.refs]]#references,1:#*))
+## Summary
+## Flow
+- engine-server/src/topics/markdown/plugins/dendronRefsPlugin.ts
+- data:
+  - [[replaceRefs|dendron.scratch.2020.09.12-091632]]
+```ts
+dendronRefsPlugin({..., replaceRefs}) {
+    // match note ref
+    match := /^\(\((?<ref>[^)]+)\)\)/.match(text)
+    stringify(link) := {
+      body = read(join(root, link.name + ".md))
+      bodyAST = getProcessor.parse(body)
+      refRange = calculateRefRange(body, link)
+      bodyAST.children = bodyAST.children.slice(refRange)
+      out = getProcessor().stringify(bodyAST);
+      ...
+      if (renderWithOutline) {
+        link = getProcessor()
+          .use(replaceRef, {
+            wikiLink2Html: true
+          })
+          .process(link)
+        return doRenderWithOutline(link, ...)
+      }
+      return out
+    }
+}
+```
+- engine-server/src/topics/markdown/plugins/replaceRefs.ts
+```
+replaceRefs(node) {
+  if node.type == 'wikilink' {
+  }
+}
+```
+## Related
+- engine-server/src/utils.ts
+```ts
+parseDendronRef {
+  ...
+}
+```
+# Reference
+## Refresh Node
+- loc: engine-server/src/engine.ts
+```ts
+refreshNodes(nodes) {
+  ...
+  type = nodes[0].type
+  if type == schema {
+  } else {
+    ...
+  }
+  @updateLocalCollection nodes {
+    @schemaFuse.setCollection nodes
+  }
+  @store.updateNodes nodes
+}
+```

Added: vault/dendron.dev.design.files-vs-folders.md

Files changed (1) hide show

vault/dendron.dev.design.files-vs-folders.md +26 -0

vault/dendron.dev.design.files-vs-folders.md ADDED Viewed

@@ -0,0 +1,26 @@
+---
+id: da241d31-8a05-429c-a041-02ac6170bf20
+title: Dotted filenames
+desc: ''
+updated: 1600270046572
+created: 1600270046572
+stub: false
+---
+- note renames are simpler, no need to create / delete folders
+- note containers can be created with a single artifact (e.g. foo.bar.md is the container for foo.bar vs. foo/bar.md + foo/bar/)
+- note stubs can be created without intermediate folders
+# Folder Hierarchies
+- familiarity - dendron file structure looks like any other part of the file system. Less to learn, faster to adopt
+- you can place any files (e.g. pdfs, xlsx or draw.io diagrams) into the folders without renaming them (and reference them with the same mechanics)
+- easier to save files into the right place of the structure without the assistance of vscode (e.g. normal drag-and-drop works)
+- natural "zoom" functionality into the structure (just open the folder)
+- filenames look cleaner in vscode (in several views, like explorer, file tabs, git etc) as well as in normal OS utilities
+- large amount of files in the same folder makes normal file system tools less useful (OS file explorer, commands like ls or tree, potential choking of operations)
+- less implementation needed for dendron (e.g. no need for dendron tree view since normal file explorer works)
+- other vscode extensions rely on file structures for cleaner views (e.g. TODO tree). Not all views can be re-implemented for dendron
+- normal file system permissions could be used to limit visibility to certain sub-hierarchies
+- various sub-parts of the hierarchy can be brought into the same workspace via symlinks
+- Is compliant with enterprise setting, many companies just wouldn't adopt dot-based hierarcies for their knowledge-base (it's "too weird", "unproven" etc.)

Added: vault/dendron.dev.design.lookup.md

Files changed (1) hide show

vault/dendron.dev.design.lookup.md +136 -0

vault/dendron.dev.design.lookup.md ADDED Viewed

@@ -0,0 +1,136 @@
+---
+id: 99f7dd68-b2dc-46d0-a556-8a607223dc25
+title: Lookup
+desc: ''
+updated: 1604600828175
+created: 1602392064100
+stub: false
+---
+## Lookup Command
+- src: plugin-core/src/components/lookup/LookupControllerV2.ts
+```ts
+show {
+    ...
+    provider = new LookupProviderV2
+    picker :=
+    @updatePickerBehavior(provider, picker)
+    quickPick.onDidTriggerButton = ...
+    ...
+    provider.provide(quickPick)
+    ...
+    quickPick.show
+}
+```
+### updatePickerBehavior
+```ts
+updatePickerBehavior(quickpick, provider) {
+    buttons :=
+    selectedPath := buttons
+    selectedSelection := buttons
+    switch selectedPath {
+        case journal {
+            quickpick.value :=
+            provider.onUpdatePickerItem(
+                ....
+            )
+        }
+    }
+    switch selectedSelection {
+        case {
+            ...
+        }
+    }
+}
+```
+### provide
+- file: src/components/lookup/LookupProviderV2.ts
+```ts
+provider picker {
+    picker.onDidAccept = @onDidAccept
+    picker.onDidChangeValue = @onUpdatePickerItem
+}
+```
+## Lookup Modifiers
+```ts
+cons(opts) {
+    lookupSelectionType := CONFIG.DEFAULT_LOOKUP_CREATE_BEHAVIOR
+    noteSelectionType := opts
+    effectTypes := opts
+    types = [lookupSelectionType, noteSelectioType, effectTypes]
+    this.state {
+        buttons: createAllButtons(types)
+    }
+}
+show {
+    picker := createPicker
+    ...
+    @updatePickerBehavior(picker)
+    @refreshButtons(picker, @state.buttons)
+    picker.onTriggerButton = @onTriggerButton
+}
+onTriggerButton(btn) {
+    btnTriggered := find(state.buttons, btn)
+    btnTriggered.pressed = !btnTriggered.pressed
+    btnCategory := btn
+    ...
+    @refreshButtons(picker, @state.buttons)
+    @updatePickerBehavior
+}
+updatePickerBehavior {
+    ...
+    @updateBehaviorByEffect
+    @updateBehaviorByNoteType
+}
+updateBehaviorByEffect {
+    effectButtons.map(btn.handle)
+}
+updateBehaviorByNoteType {
+    ...
+    provider.onUpdatePickerItem(quickPick, provider.opts, onUpdateReason);
+}
+```
+```ts
+onUpdatePickerItem(picker) {
+    showRootResults if (qs == "")
+    updatedItems = picker.items
+    if (qs.endsWith(.) || query.levels < 2 || picker.justActivated) {
+        resp = engine.query
+        updatedItems = [noActiveItem] + resp
+    }
+    ...
+    addSchemaSuggestions(qs)
+}
+```

Added: vault/dendron.dev.design.md

Files changed (1) hide show

vault/dendron.dev.design.md +85 -0

vault/dendron.dev.design.md ADDED Viewed

@@ -0,0 +1,85 @@
+---
+id: c160ddce-edec-4f6e-841b-418d6030fa37
+title: Design
+desc: ''
+updated: 1613007487633
+created: 1598651922993
+stub: false
+---
+## Overview
+Dendron is composed of three main components and a collection of complementing libraries.
+Below is a sketch of the General Architecture
+```
+|Dendron Plugin| (vscode) <-> |API Server <-> Dendron Engine| (local express server)
+```
+## Major Components
+### Dendron Plugin
+- name: @dendronhq/plugin-core
+- [repo](https://github.com/dendronhq/dendron/tree/master/packages/plugin-core)
+This is the Dendron VSCode extension
+### Dendron Engine
+- name: @dendronhq/engine-server
+- [repo](https://github.com/dendronhq/dendron/tree/master/packages/engine-server)
+This is responsible for Dendron's hierarchal index and lookup capabilities. It also contains Dendron specific markdown parsers. While the name says `server`, there is no server that comes with the engine
+### Dendron API Server
+- name: @dendronhq/api-server
+- [repo](https://github.com/dendronhq/dendron/tree/master/packages/api-server)
+This package contains the express server implementation for Dendron. It provides a REST based shim to allow the Dendron plugin to talk to the engine.
+## Other Components
+### Dendron Common All
+- name: @dendronhq/common-all
+- [repo](https://github.com/dendronhq/dendron/tree/master/packages/common-all)
+This is a bunch of types and utilities that is consumed by multiple Dendron dependencies
+### Dendron Common Server
+- name: @dendronhq/common-server
+- [repo](https://github.com/dendronhq/dendron/tree/master/packages/common-server)
+This is common utilities that are used by server-side versions of Dendron (currently, this is the only available built of Dendron - in the future, the plan is to have a browser only client)
+### Dendron CLI
+- name: @dendronhq/dendron-cli
+- [repo](https://github.com/dendronhq/dendron/tree/master/packages/dendron-cli)
+This package lets you access Dendron via CLI.
+<!-- ### Dendron Server
+This packages contains the vscode LSP server implementation for Dendron. The LSP server will start the `Dendron Express Server` in order to query the engine. -->
+<!-- ### LSP Related functionality
+```
+Dendron Plugin <-> LSP Server <-> Express Server <-> Dendron Engine
+``` -->
+<!-- ### Non-LSP Functionality -->
+<!-- - if no server is set
+```
+Dendron CLI <-> Dendron Engine
+```
+- if server is set (able to use engine instead of re-indexing)
+```
+Dendron CLI <-> Express Server <-> Dendron Engine
+```
+ -->

Added: vault/dendron.dev.design.pods.md

Files changed (1) hide show

vault/dendron.dev.design.pods.md +55 -0

vault/dendron.dev.design.pods.md ADDED Viewed

@@ -0,0 +1,55 @@
+---
+id: 92a4f470-1803-4dce-8872-1a7009d8500b
+title: Pods
+desc: ''
+updated: 1608485512282
+created: 1602714464908
+stub: false
+---
+## Export Pod
+- execute
+```bash
+dendron-cli export-pod
+```
+- src/commands/pod.ts
+```ts
+enrichArgs {
+    podClass :=
+    config = getPodConfig :=
+    if !config {
+        throw "no-config"
+    }
+}
+execute {
+    podClass, config :=
+    new podClass().plant(config)
+}
+```
+- src/builtin/JSONPod.ts
+```ts
+plant {
+    cleanConfig :=
+    payload = prepareForExport()
+    destPath :=
+    write(destPath, payload)
+}
+```
+- src/base.ts
+```ts
+prepareForExport {
+    @initEngine
+    nodes :=
+    ...
+    return nodes
+}
+```

Added: vault/dendron.dev.design.publishing.md

Files changed (1) hide show

vault/dendron.dev.design.publishing.md +45 -0

vault/dendron.dev.design.publishing.md ADDED Viewed

@@ -0,0 +1,45 @@
+---
+id: 8ec553b8-5dfc-4a72-b73f-25c8e59d1538
+title: Publishing
+desc: ''
+updated: 1599927898931
+created: 1599927898931
+stub: false
+---
+## Summary
+## Flows
+- src/commands/build-site.ts
+```ts
+siteHierarchies := read(dendron.yml)
+nav_order = 0
+nodes = siteHierarchies { hRoot
+    note := engine.notes[hRoot]
+    note.nav_order = nav_order
+    note.parent = null
+    ...
+}
+...
+while nodes {
+    node = nodes.pop
+    note2JekyllMdFile(node, {
+        notesDir: siteNotesDirPath
+    })
+}
+```
+- src/commands/build-site.ts
+```ts
+note2JekyllMdFile {
+    ...
+    note.body = getProcessor()
+        ...
+        .process(note.body)
+}
+```

Added: vault/dendron.dev.design.remark.md

Files changed (1) hide show

vault/dendron.dev.design.remark.md +88 -0

vault/dendron.dev.design.remark.md ADDED Viewed

@@ -0,0 +1,88 @@
+---
+id: d8a09d7b-8693-437c-8a2c-2bfe0b3c2768
+title: Remark
+desc: ''
+updated: 1604676771824
+created: 1602033034187
+stub: false
+---
+## Summary
+This goes over how Dendron parses markdown files
+## Init
+### Get Processor
+This starts markdown parsing. It's called in multiple points (eg. dendron-cli, dendron markdown preview enhanced, etc) when markdown needs to be converted.
+- file: engine-server/src/topics/markdown/utils.ts
+```ts
+getProcessor()
+    .use(markdownParse, { gfm: true })
+    .use(frontmatterPlugin, ["yaml"])
+    .use(dendronLinksPlugin)
+    .use(dendronRefsPlugin, { root, renderWithOutline, replaceRefs })
+    .use({ settings: { listItemIndent: "1", fences: true } });
+```
+## Note References
+References are parsed using the `dendronRefsPlugin`.
+- file: engine-server/src/topics/markdown/plugins/dendronRefsPlugin.ts
+### Parse
+```ts
+plugin.inlineTokenizer(eat, value) {
+    if match(eat, DENDRON_REF):
+        link := match
+        return {
+            type: refLink,
+            value: normalize(link)
+        }
+}
+```
+### Stringify
+```ts
+plugin.Compiler {
+    visitor.refLink(content) {
+        link :=
+        bodyOfTarget = read(link)
+        markers = findRef(link, bodyOfTarget)
+        return modifyContent(content, markers)
+    }
+}
+```
+## Replace Links
+```ts
+getRemark(opts) {
+    dendronLinksOpts := opts
+    remark()
+        ...
+        .use(dendronLinksPlugin, dendronLinksOpts)
+}
+```
+- src/topics/markdown/plugins/dendronLinksPlugin.ts
+```ts
+plugin.Compiler({replaceLink}) {
+    if replaceLink {
+        node.value = replaceLink.to.fname;
+        if node.data.alias != replaceLink.from.fname {
+            node.data.alias = opts.replace.to.fname
+        }
+    }
+}
+```

Added: vault/dendron.dev.design.seeds.md

Files changed (1) hide show

vault/dendron.dev.design.seeds.md +30 -0

vault/dendron.dev.design.seeds.md ADDED Viewed

@@ -0,0 +1,30 @@
+---
+id: 6a801f8a-af4a-4665-9ee5-144877e7cad7
+title: PlantSeed
+desc: ''
+updated: 1602890605707
+created: 1602890605707
+stub: false
+---
+- file: src/commands/plantSeed.ts
+```ts
+execute( id ){
+    SeedClass := id
+    new SeedClass().plan()
+}
+```
+- src/base.ts
+```ts
+plant {
+    config = this.config()
+    metadata = @fetch(config)
+    @engine.init()
+    notes, assets = @prepare
+    @writeAssets assets
+    @writeNotes nots
+}
+```

Added: vault/dendron.dev.issues.md

Files changed (1) hide show

vault/dendron.dev.issues.md +15 -0

vault/dendron.dev.issues.md ADDED Viewed

@@ -0,0 +1,15 @@
+---
+id: af2ba46a-4dbc-4648-9d4c-f6d6d2e3bb50
+title: Issues
+desc: ''
+updated: 1608593535254
+created: 1608593449583
+---
+### gyp issue when installing
+- Call to 'krb5-config gssapi --libs' returned exit status 127 while in binding.gyp. while trying to load binding.gyp
+```bash
+yum install make glibc-devel gcc patch
+```

Added: vault/dendron.dev.md

Files changed (1) hide show

vault/dendron.dev.md +15 -0

vault/dendron.dev.md ADDED Viewed

@@ -0,0 +1,15 @@
+---
+id: 3489b652-cd0e-4ac8-a734-08094dc043eb
+title: Development
+desc: ''
+updated: 1604511673556
+created: 1598645869692
+stub: false
+nav_order: 9.6
+---
+If you would like to contribute to the development of dendron, you can do so by checkout out the [repo](https://github.com/dendronhq/dendron) from github.
+You can then follow the setup instructions below to prepare your first commit!
+((ref:[[dendron.dev.setup]]#getting started))

Added: vault/dendron.dev.ref.kevins-setup.md

Files changed (1) hide show

vault/dendron.dev.ref.kevins-setup.md +27 -0

vault/dendron.dev.ref.kevins-setup.md ADDED Viewed

@@ -0,0 +1,27 @@
+---
+id: 10e86d42-e3e3-4aae-92ad-c086b776f34e
+title: Kevins Setup
+desc: ''
+updated: 1612801485282
+created: 1612801401299
+---
+Dendron has a lot of moving parts so I try to divide my workspace accordingly.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dev.kevin.jpg)
+- 1: What I'm working on
+- 2 and 3: Related project (eg. if 1 was the plugin, 2 & 3 might be `engine-server` and `api-server` respectively)
+- 4 and 5: This is where I keep common utils/libs (eg. `common-all`, type definitions, etc)
+Since your screen space can be pretty small when doing this, I use the following keyboard shortcut to trigger maximizing panes
+```json
+{
+    "command": "workbench.action.toggleEditorWidths",
+    "key": "ctrl+cmd+m"
+}
+```
+I also try to document the main logic when I run into it in the {project}.internals hierarchy on our site: https://dendron.so/notes/4b8f0470-dacb-433b-8d0c-f5a7d8f5245d.html

Added: vault/dendron.dev.ref.lifecylce.md

Files changed (1) hide show

vault/dendron.dev.ref.lifecylce.md +18 -0

vault/dendron.dev.ref.lifecylce.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+id: 5e164216-c464-4a6f-ae85-a6f5cbc787e7
+title: Extension
+desc: ''
+updated: 1608754259470
+created: 1604341985772
+---
+- not_initialized
+  - tried starting workspace but something went wrong
+- initialized
+  - reloadWorkspace complete
+  - **upgraded**
+  - upgrade workspace complete
+- upgraded (optional)
+  - extension has upgraded
+- activate
+  - finish showWelcome

Added: vault/dendron.dev.ref.md

Files changed (1) hide show

vault/dendron.dev.ref.md +13 -0

vault/dendron.dev.ref.md ADDED Viewed

@@ -0,0 +1,13 @@
+---
+id: b5736273-85ad-4d0c-bb30-89c92a3941da
+title: Ref
+desc: ''
+updated: 1604418668529
+created: 1604418668529
+stub: false
+parent: 3489b652-cd0e-4ac8-a734-08094dc043eb
+children:
+  - 5e164216-c464-4a6f-ae85-a6f5cbc787e7
+---

Added: vault/dendron.dev.ref.vscode.md

Files changed (1) hide show

vault/dendron.dev.ref.vscode.md +17 -0

vault/dendron.dev.ref.vscode.md ADDED Viewed

@@ -0,0 +1,17 @@
+---
+id: 3307c16e-69d9-48cd-b1cc-1dfe88274191
+title: Vscode
+desc: ''
+updated: 1614837534125
+created: 1608754262068
+---
+## Tasks
+- [vscode docs](https://code.visualstudio.com/docs/editor/tasks)
+- workspace specific way of executing scripts
+## Debug Pane
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dev.vscode-debug.jpg)

Added: vault/dendron.dev.setup.md

Files changed (1) hide show

vault/dendron.dev.setup.md +87 -0

vault/dendron.dev.setup.md ADDED Viewed

@@ -0,0 +1,87 @@
+---
+id: 64f0e2d5-2c83-43df-9144-40f2c68935aa
+title: Setup
+desc: ''
+updated: 1614313342658
+created: 1598651458825
+stub: false
+---
+## Getting Started
+### 1. Requirements
+Before you begin, you need to make sure to have the following SDKs and tools:
+- [Node.js >= 12.0.0](https://nodejs.org/download/release/latest-v10.x/)
+  - We recommend using a version in [Active LTS](https://nodejs.org/en/about/releases/)
+### 2. Clone and npm install
+```bash
+git clone https://github.com/dendronhq/dendron.git
+cd dendron
+npm install
+```
+### 3. Build Repo
+- you should run this when building dendron for the first time and also every time you run a git pull
+  - new dependencies might have been picked up between pulls and this makes sure that they are installed
+```bash
+yarn bootstrap:bootstrap
+yarn bootstrap:build
+```
+- we recommend you use `vscode` to develop for dendron. there is a `dendron.code-workspace` file in the root of the monorepo that you should use when developing
+### 4. Editing (the plugin)
+At the root of the monorepo, open `dendron-main.code-workspace`. Open this with VSCode to start editing. While its not required to use VSCode, most of the helper scripts in this repository are created with VSCode in mind so using it will make development significantly easier.
+### 5. Start Debugging (the plugin)
+- NOTE: you don't need to do this if you are not directly working on the extension (eg. you're working on the [[server|dendron.pro.dendron-next-server]])
+To start an instance of the Dendron with the Debugger, Run `Extension (plugin-core)` from the debug panel in vscode
+![debugger](/assets/images/start_debugger.gif)
+_Note: Running via Run -> Start Debugging will not work unless you've previously targeted `Extension (plugin-core)`_
+## Tips
+### Watch Monorepo
+To continuously compile all dependencies, run the following
+```bash
+./bootstrap/scripts/watch.sh
+```
+## Troubleshooting
+### Something went wrong during the build
+In case something something goes wrong with a build step or you want to save time by not running everything, `init.sh` is just a thin wrapper around the following scripts, each of which can be run individually
+- ./bootstrap/scripts/bootstrap.sh: `lerna bootstrap all packages`
+- ./bootstrap/scripts/build.sh: `lerna build all packages`
+### Changes not showing up in Dendron
+1. Are you using the `Run extension` command on the debugger panel to test dendron?
+2. If you have one vscode instance which you have dendron installed and are also doing dendron development on, you might get a version conflict. in that case, use `Run extension with plugin disabled` in the debugger panel (or use a different version of vscode to run dendron vs develop)
+## Testing
+- see [[Testing|dendron.dev.testing]]
+## Debugging
+- see [[Debugging|dendron.dev.debug]]
+## Style
+- see [[Style|dendron.dev.style]]

Added: vault/dendron.dev.style.md

Files changed (1) hide show

vault/dendron.dev.style.md +12 -0

vault/dendron.dev.style.md ADDED Viewed

@@ -0,0 +1,12 @@
+---
+id: 773e0b5a-510f-4c21-acf4-2d1ab3ed741e
+title: Style
+desc: ''
+updated: 1609550434732
+created: 1609550314371
+---
+Code style guidelines. We use [prettier](https://prettier.io/) to autoformat the code on every commit which helps with most conventional styling conventions. This page lists some additional conventions not covered by prettier.
+- when importing modules, unless your working with an all javascript package, we want to use `import` syntax over `require` syntax
+- unless there's an obvious performance penalty, we prefer using `async/await` and `Promises` over callbacks

Added: vault/dendron.dev.testing.md

Files changed (1) hide show

vault/dendron.dev.testing.md +90 -0

vault/dendron.dev.testing.md ADDED Viewed

@@ -0,0 +1,90 @@
+---
+id: cb22bd36-d45a-4ffd-a31e-96c4b39cb7fb
+title: Testing
+desc: ''
+updated: 1610816383624
+created: 1598654055046
+stub: false
+---
+## Overview
+See remote pairing session for an overview of setting up tests.
+<iframe width="560" height="315" src="https://www.youtube.com/embed/ueMhGDwMP9M" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+- [[Session notes|dendron.dev.testing.notes]]
+## Running All Tests
+### All packages except the plugin
+- Inside VSCode
+  > Run Task: Test (bootstrap)
+- Using CLI
+```bash
+./bootstrap/scripts/testAll.sh
+```
+### Run all test for Dendron Plugin (plugin-core)
+1. Open the debug view
+2. Run `Extension Integ Tests` in the dropdown
+## Run Specific Test
+### Run a specific test for Dendron Plugin
+1. Open a test inside 'src/test/suite-integ/' from `plugin-core`
+2. Run the build task `Extension Integ Tests - File`
+### Run a specific test from non-dendron plugin package
+1. Go to file
+2. Use command prompt and run `> Tasks: Run tasks`
+3. Find the appropriate package and run `> npm:test:watch {package}`
+## Writing Tests
+All packages have tests written in `jest` except plugin-core. these tests use `mocha` assertion because vscode has a special test harness built around `mocha`
+## Debugging Tests
+You can put a breakpoint directly in any code that's part of `plugin-core` and it'll break at those points
+> Kevin's Aside: If you need to debug a related package, I haven't found a good way to put a break point. Instead, I manually insert a `debugger` statement and vscode will break. Don't forget to remove the `debugger` statement
+## Anatomy of an Engine Test
+- pre-req:
+  - read over the overall [[design|dendron.dev.design#overview]] for Dendron
+Testing the engine in Dendron involves a little bit of setup because:
+- it requires initializing the engine and seeding it with the right fixture for the test
+- it might require the same functionality be tested in multiple environments (plugin, CLI, server, engine, etc)
+- it might require using multiple test runners (dendron uses `jest` for all tests except for the [[dendron plugin|dendron.dev.design#dendron-plugin]] which uses [[mocha|dendron.pro.dendron-plugin.qa#test-runner]])
+Because of the aforementioned issues, we've created the following two classes to make testing easier and re-usable across environments.
+### runEngineTest
+- setup a mock dendron environment
+- initialize the dendron engine
+- optionally seed engine with a preset
+- NOTE: there are currently multiple versions of this which track multiple generations of engine design
+  - the most current version is `runEngineTestV5`
+  - see example of usage [here](https://github.com/dendronhq/dendron/blob/master/packages/engine-test-utils/src/__tests__/site.spec.ts#L84:L84)
+### TestPresetEntry
+- [code](https://github.com/dendronhq/dendron/blob/master/packages/common-test-utils/src/utilsv2.ts#L48:L48)
+- this helps us create a `TestPreset` which is to be used with `runEngineTest`
+- lets you add different lifecycle hooks as the engine is beign initialized
+- NOTE: there are currently multiple versions of this
+  - the most current version is `TestPresetEntryV4`

Added: vault/dendron.dev.testing.notes.md

Files changed (1) hide show

vault/dendron.dev.testing.notes.md +66 -0

vault/dendron.dev.testing.notes.md ADDED Viewed

@@ -0,0 +1,66 @@
+---
+id: bf26c697-3e70-4e34-b15d-ef40c4b7d429
+title: Notes
+desc: ''
+updated: 1610816370506
+created: 1610816231328
+---
+Thank you [Mark H. Choi](https://github.com/hikchoi/cerebrarium) for the below notes
+## Session goal
+- Add a test for MarkdownPublishPod
+- Show how tests are set up for Dendron
+## watch
+```bash
+cd bootstrap/scripts
+./watch.sh
+```
+- Dendron is made up of a multiple typescript projects
+- This script will watch all of them and compile them when you make change to the code.
+---
+## Testing in Dendron
+- All tests are managed with jest.
+    - Except the plugin itself, which uses mocha
+        - mocha is very well integrated into VSCode's [test harness](https://en.wikipedia.org/wiki/Test_harness)
+- Any test code that are not testing plugin functionality are
+    - located in the `__tests__` directory
+    - in the file name formatted `TestName.spec.ts`
+- To run a test, use VSCode tasks
+    - `cmd` + `shift` + `p`, -> `Task: Run Task` in the command palette
+    - Select the appropriate task to run.
+        - These are vscode wrappers around bash scripts.
+    - In our case, we want to test `MarkdownPod.spec.ts`
+    - Type `npm:test:watch` in the task comman palette
+    - There will be a number of selections, marked with which project's test it will be running.
+        - Select the one marked with `pods-core`, as we are testing pods today.
+    - This will open a terminal and run `jest --watch` on the specific test we are interested in.
+        - Now jest will run all the tests for you every time you change your test code
+- Writing new tests
+    - Start a new [describe block](https://jestjs.io/docs/en/api#describename-fn), and give it an appropriate name.
+    - Write a new test case.
+        - Use `runEngineTest`
+            - Multiple versions of this exists
+            - Make sure you import the right version of this.
+                - This is a typescript thing (?)
+        - There are preset scenarios for testing
+            - These are `PreSetupHookFunctions`
+            - They set up hard-coded notes in a vault so that they can be used in a test
+    - Quick jest tip: use snapshots to grab a test result (something long that you don't really want to construct manually), and use that for your assertions
+        - These can be found in `__tests__/__snapshots__`
+        - Don't forget to remove the snapshot code for the final test code if it isn't necessary.
+    - Clean up any unused code / warnings
+- After writing all the tests, check again by running the entire test suite
+    - Run `Test: bootstrap` found under `Task: Run Task`
+        - This will all tests in all packages.
+        - We want to do this before commiting because Dendron is a mono-repo, and most packages have dependencies on each other.
+        - We want to make sure our changes aren't breaking something elsewhere.
+        - Github action that will automatically do this for every push will be coming soon.
+- If you want to be more careful, you can also test the plugin itself at this point.
+    - The above step tests every single package that is not a plugin.
+    - To run tests for the plugin itself, run `Extension Integ Tests (plugin-core)`, which can be found in the Run pane.

Added: vault/dendron.dev.triage.md

Files changed (1) hide show

vault/dendron.dev.triage.md +97 -0

vault/dendron.dev.triage.md ADDED Viewed

@@ -0,0 +1,97 @@
+---
+id: 1e6c8b49-ef88-4e79-b2df-e9d614c38a53
+title: Triage
+desc: ''
+updated: 1613821943272
+created: 1610468038819
+---
+This describes how Dendron [issues](https://github.com/dendronhq/dendron/labels?page=1&sort=name-asc) are laid out in github.
+## general
+### Epic
+This is a collection of multiple tasks
+## area
+different components of dendron
+### hierarchy
+Everything that has to do with the hierarchy's be it the schema files or other things where they play a role.
+### workbench
+If you have problems with the workbench components that get provided by dendron like the "Dendron Tree View" or the "Backlink" panel.
+### pods
+Everything about pods, requests for new ones or problems with existing ones
+### seeds
+Everything about seeds, requests for new ones or problems with existing ones
+### markdown
+Features or issues with the parsing of markdown and it's related syntax
+### engine
+Dendron backend
+### publishing
+Publishing related features
+### ui
+WebView related functionality
+#### graph
+Features or Issues related to the Graph
+## size
+### small
+good first task
+### medium
+good task after you have done a few `small` tasks
+### large
+big undertaking, might take a few days and touches multiple components
+## status
+### help-wanted
+feature not in scope of current timeline. looking for outside contributors
+### pending
+waiting for response from submiter
+### triage-needed
+everything that has this label still needs to be looked over by a Contributor or member of [Dendronhq](https://github.com/dendronhq)
+## type
+### bug
+Everything that does not work as intended lands here
+### enhancement
+Improvements to existing features
+### feature
+Requests for new Features land here

Added: vault/dendron.dev.windows.md

Files changed (1) hide show

vault/dendron.dev.windows.md +44 -0

vault/dendron.dev.windows.md ADDED Viewed

@@ -0,0 +1,44 @@
+---
+id: d0f34b08-0725-4ec5-a600-a4d6309bb2ae
+title: Windows
+desc: 'Windows gotchas'
+updated: 1615168192996
+created: 1615165852271
+---
+The Dendron VSCode extension is built in TypeScript and uses a lot of JavaScript tooling to build and compile, and does not always play nice with Windows.
+Here are some of the things to look out for.
+## git
+Most of the Dendron developers use Mac or Linux, so the file endings and permissions are not the same.
+After you build Dendron, git will pick up a lot of file changes that don't actually exist [^diff].
+In order to fix this (preferably do this before building Dendron):
+- Create a .gitattributes file in the root of the Dendron repo and add `* text=auto` [^lineendings]
+- run `git config --add core.filemode false` on the repo [^chmod]
+If you are still seeing blank changes in git run:
+- `git add --renormalize .` [^diff] (yes there is a single dot at the end of the command.)
+## watch script
+Dendron has a watch.sh script which will continuously compile all dependencies while you are developing. This is useful, but windows does not run shell scripts natively...
+The easiest way to run shell scripts on Windows is to use git BASH[^git][^gitbash], which gets automatically installed, when you install git for windows. (It should also already be on your PATH.)
+Open git BASH inside the Dendron repo and run the script:
+```
+./bootstrap/scripts/watch.sh
+```
+[^diff]: [git status shows changed files but git diff doesn't](https://stackoverflow.com/questions/14564946/git-status-shows-changed-files-but-git-diff-doesnt)
+[^chmod]: [How do I make git ignore file mode (chmod) changed?](https://stackoverflow.com/questions/1580596/how-do-i-make-git-ignore-file-mode-chmod-changes)
+[^lineendings]: [How to change line-ending settings](https://stackoverflow.com/questions/10418975/how-to-change-line-ending-settings)
+[^git]: [git for Windows](https://gitforwindows.org/)
+[^gitbash]: [How to run shell scripts on Window](https://www.thewindowsclub.com/how-to-run-sh-or-shell-script-file-in-windows-10) See last comment

Added: vault/dendron.faq.md

Files changed (1) hide show

vault/dendron.faq.md +238 -0

vault/dendron.faq.md ADDED Viewed

@@ -0,0 +1,238 @@
+---
+id: 683740e3-70ce-4a47-a1f4-1f140e80b558
+title: FAQ
+desc: ''
+updated: 1612368130856
+created: 1595952505025
+stub: false
+nav_order: 6
+---
+All the questions we thought you might ask.
+## General
+### What is a Dendron?
+A Dendron is many things.
+1. Dendron is the greek word for tree. It's a reference to the hierarchal note taking that Dendron(3) enables.
+2. Dendron is another word for [dendrite](https://en.wikipedia.org/wiki/Dendrite) which is an extension of the nerve cell that sends and receives signals in the brain. Think of Dendron(3) as a digital nervous system that helps you consolidate all the information that you care about in the fastest and most efficient way possible.
+   ![](https://upload.wikimedia.org/wikipedia/commons/thumb/b/bc/Neuron_Hand-tuned.svg/2880px-Neuron_Hand-tuned.svg.png)
+   - Image by Quasar Jarosz at English Wikipedia
+3. Dendron is a local-first, markdown based, hierarchical note taking tool. It is meant to help you organize, manage, publish, and collaborate on knowledge bases of any size.
+### How is Dendron different from X note taking tool?
+Substitute X with `roam|obsidian|foam|one note|evernote|...`
+All note taking tools (try to make it) easy to get notes in. Its getting it back out again that's hard and it **becomes harder** as you get more notes.
+Whether you are using notebooks tags, or backlinks, once you have more than a few hundred notes, you'll need to have some sort of structure in place (eg. naming convention, hierarchy, etc) to keep track of it.
+Dendron is a highly opinionated note taking tool that focuses on **hierarchal note taking**. It provides the freedom of Roam's _every note exists everywhere philosophy_ while layering on top **flexible hierarchies** to keep track of it all.
+While Dendron works with knowledge bases of any size, it really shines once you've accumulated a few hundred notes. I created it to handle my personal knowledge base of 20k+ markdown notes - Dendron lets me track and find any specific note in it in seconds. You can read more about Dendron's hierarchal approach to note taking [here](https://www.kevinslin.com/notes/3dd58f62-fee5-4f93-b9f1-b0f0f59a9b64.html).
+### How is Dendron different from Roam?
+Whereas Roam is built around the idea of **bi-directional links** (and daily journals) which help you create notes without having to explicitly organize your notes, Dendron is built to help you organize notes without friction using **flexible hierarchies**.
+We provide the tooling to create, enforce, and change these hierarchies at will. If you think of Roam as a graph database for notes, you can think of Dendron as Redis. To give you a sense of scale, I use Dendron to manage a corpus of +20K notes.
+Some additional features that set Dendron apart:
+- Dendron allows you to compose your workspace with vaults (a vault is a collection of notes that can come from anywhere) from any number of sources
+- Dendron is based on plain text (Dendron flavored) markdown (exportable to regular markdown or any other format)
+- Dendron is integrated into VSCode
+- Dendron allows for easy publishing public/private content to any platform that can host a static site (and we're rolling out our own publishing platform to help people publish with additional access controls)
+### How does Dendron help me track my notes?
+1. Dendron organizes and collapse all your  notes into managable chunks using [[hierarchies|dendron.topic.hierarchies]].
+2. Dendron helps you manage your hiearchies using [[schemas|dendron.topic.schema]]
+3. Dendron gets out of your way when your working with your notes during [[lookup|dendron.topic.lookup]]
+Dendron's secret sauce is that it provides the necessary tooling for you to work with hierarichal notes. While hierarchies have traditionally (and justifiably) gotten a bad, I would argue that this is because the **tooling** around hierarchies were bad, not because hierarchies themselves are bad.
+Hierarchies are one of the most effective ways that **both humans and computers** process large amount of information (there's a reason why almost every database is built from a variation of the [b-tree](https://en.wikipedia.org/wiki/B-tree)). You can find further details about hierarchies in this [blog post](https://www.kevinslin.com/notes/e1455752-b052-4212-ac6e-cc054659f2bb.html)
+### Is Dendron Free? Will it stay free?
+Dendron, the client, is free and will always remain free. It is also open source so anyone is free to make their own fork of Dendron.
+That being said, I'm all in on Dendron and this is my full time gig. I want to make sure that developing Dendron remains sustainable. To that end, I plan on introducing value add server side functionality that folks may pay for. Examples of paid for features include:
+- private hosting (for folks who want to publish but not use github pages or want to add authentication)
+- enterprisy things
+  - eg. on premise installations of Dendron with single sign on, active directory, and fine grained permissions
+- offering private subscription based vaults (eg. think [substack](https://substack.com) but having people subscribe to vaults instead of newsletters )
+- server side IFTTT like functionality (eg. everytime I add an entry to airtable, add a note to Dendron)
+Paid for features will be 100% optional and will not be necessary for any client side functionality in Dendron.
+### Why is Dendron built on top of VSCode?
+As with all things, its a matter of tradeoffs. Dendron started its life as a standalone app (eg. think Obsidian) but I quickly realized I was spending most of my time building undifferentiated editor scaffolding instead of focusing on the hierarchies and schemas that made Dendron unique.
+I wanted to spend more time building out features that supported Dendron's [hiearchy first approach](https://www.kevinslin.com/notes/3dd58f62-fee5-4f93-b9f1-b0f0f59a9b64.html) to note taking which is what led me to re-write it for VSCode.
+That being said, the core dendron engine is not vscode specific and there are folks that are experimenting with porting it over to other editors (eg. sublime, vim). We also have plans for a standalone editor in the future (most likely, this will be a fork of VSCode optimized for note taking)
+## Working with Notes
+### Why markdown?
+Markdown lets you write text in a simple human readable notation that is platform independent. You don't need to have microsoft word to read a markdown file and now a days, all new note taking tools support importing and displaying markdown.
+For more context, you can see the original markdown declaration [here](https://daringfireball.net/projects/markdown/)
+### Can I use Dendron with existing notes?
+You can use Dendron with existing repositories of markdown notes.
+Open the `Command Bar` in vscode and use the `Dendron: Change Workspace` command. It will ask you for a folder path as input.
+Dendron will create a `dendron.code-workspace` file in specified directory and then open the workspace (if a workspace file already exists, it will use that). It will also create a `root.md` file in that directory if it doesn't exist (currently this is part of the internal working of dendron).
+Dendron **does not** delete or overwrite any files during the **Change Workspace** operation.
+### How do I save?
+Dendron automatically saves when you change focus (switch tabs or applications). You can also manually save using `Cmd+S` or `Ctrl+S` depending on your operating system
+### How do I go back to the previous note?
+There are 3 ways to go back to my previous note:
+1. `ctrl-tab` (go to previous tab)
+2. click on the previous tab
+3. using the open editors pane
+- NOTE: to have more than a single tab show, you need to have the following settings
+```json
+{
+    "workbench.editor.enablePreview": false,
+    "workbench.editor.showTabs": true
+}
+```
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/faq.go-back.gif)
+## Working with Hierarchies
+### How should I name a note?
+There are no rigid requirements on note naming in Dendron, other than the dots in the file name are used to construct the note [[note hierarchy|dendron.topic.hierarchies]]. However, the recommended way is to use all lowercase letters, replace spaces with `-`-mark and remove any special characters. Thus e.g. `John's amazing garage` becomes `johns-amazing-garage`.
+Also, remember that you will use the note [[lookup-feature|dendron.topic.lookup]] to find notes quickly, and the lookup will use the names of the files. Thus try to name the files using the words that you are likely to use to find the note.
+### What kind of note hierarchy should I create?
+A good guideline is to start with a relatively flat hierarchy (even just a single note in the root!) and add topics as headings into those notes. When notes grow to the point that you have to start scrolling, it’s time to consider if it would be beneficial to split those notes. At that point, you probably already have some idea how the thoughts are placed in your mind - try to mimic that also with the hierarchy.
+If you have a hard time deciding which ideas belong closer to root, think which of those ideas are more fundamental in your thinking. As an example, a note related to coding in Excel, should it be named as `code.excel` or `excel.code`? This could be resolved by thinking if you will write more about coding where Excel is just one example, or more about Excel, where coding is only one example. In case you think that both `excel.code` and `code.excel` are equal and both should be created, you could also make one of them a “master note” and [[refer|dendron.topic.refs]] to it from the other note.
+### Do I have to use hierarchies? What if I want to use another approach?
+Despite our emphasis on hierarchies, Dendron also supports non-hierarchal ways of organizing notes (eg. backlinks, zettelkasten, etc).
+You can, and are encouraged to, combine these other workflows with Dendron hierarchies in order to create your own workflow that takes the best parts of each system!
+### What if I have a note that belongs in multiple hierarchies?
+This comes up a lot especially when your dealing with organizing collections of things, like music or books. There are a few approaches we recommend here.
+1. Use [[tags|dendron.topic.tags]]. Tags work best with categorical data. If you use **Dendron Tags** (aka they're really hierarchies), then you have the added advantage of being able to refactor and track your tags using Dendron's existing hierarchal tooling.
+2. Use alias nodes. This is an [upcoming feature](https://github.com/dendronhq/dendron/issues/128) that will allow you to put a node under multiple hierarchies.
+### Hierarchies add too much friction
+The hierarchy adds friction but the idea is that the friction (eg. hierarchy) is not a bug but the reason why dendron works with thousands of notes.
+The analogy to think about is excel: while putting your numbers inside the structure of a spreadsheet might not be the most straightforward way of getting to a numerical solution, its use becomes indispensable once you deal with a significant amount ofnumbers.
+The way to think about dendron is that its not like google where you type a question and try to find an answer - until we get true AI, this simply doesn't work for personal knowledge. Rather, Dendron helps you organize your notes so you can reference the information you need to answer your own questions.
+## Working with Schemas
+### What is the deal with schemas? Do I need to use them?
+The short answer is no, you don't **need** to use schemas. That being said, schemas can help you manage your notes, especially as you collect more of them.
+If you're familiar with typescript - Dendron schemas are similar to the types offered by typescript. You can compile your typescript code into javascript even if the types don't match (subject to your tsconfig). Types help make your projects maintainable, especially as they grow.
+Currently, Dendron will do is show you an indicator if your schema doesn't match. In the future, we'll have a strict mode where we will actually prevent you from creating notes that don't match your schema.
+Schemas at the end of the day help you construct consistent hierarchies for your notes. Consistent hierarchies alleviate the cognitive overhead of needing to understand and track N things where N can be very big. Instead, you can construct a single schema that encompasses the common areas of all N things.
+But even if you don't have a lot of notes, schemas are helpful because they provide extra features [like templating](https://dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#schema-templates) and [auto complete](https://dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#why-use-schemas).
+<!--
+This allows you to quickly reference anything within your hierarchy because they all have the same shape. It also helps with understanding a topic - I (Kevin, Dendron author) find my schema for a domain tends to reflect my mental model for said domain as well.
+For example, I'm using nodejs and need to access a file. I have no idea what the builtin/recommended library for file access is. Instead of having to dig up [fs-extra](https://www.npmjs.com/package/fs-extra), I can navigate to `l.node.file` and see my notes on the best way to work with files. You can replace node with any other programming language. Now I have a general way of referencing file access for all languages without needing to remember the specific implementation detail of any of them.
+-->
+## Finding Notes
+### Can I do filter by the metadata in Dendron?
+Metadata is currently under utilized because we don't have a built in way of easily querying by it. We currently have [this issue](https://github.com/dendronhq/dendron/issues/152) tracking the progress of advanced query work.
+In the future, we want to support:
+- querying by custom frontmatter attributes: <https://github.com/dendronhq/dendron/issues/152>
+- query by attributes with logical operators: <https://github.com/dendronhq/dendron/issues/159>
+We also want to support some subset of the queries as note references so that the results can be included in page.
+## Other
+### Why are there `root` files in my notes?
+When you initialize a vault, `root.md` and `root.schema.yml` get created inside each vault.
+They serve as the "roots" of your vault for your notes and schema respectively.
+root.md is used as the parent of all hierarchies, root.schema as the parent of all schemas
+root.md is what shows up when you do a lookup with an empty line ""
+root.schema.yml is a schema that is global for all hierarchies (normally, a schema is scoped to a particular hierarchy)
+Now this isn't required per-say, we could just do away with **root** notes and stick strictly to hierarchies and this might be an option in the future but this is the reasoning at the current time
+ps. root.schema.yml doesn't work right now as described in the sense that we haven't implemented global schemas yet
+### Can I use a dark theme for the markdown preview?
+Yes. There's a setting called `markdown-preview-enhanced.previewTheme` that you can set which has a list of default themes, including dark themes.
+### Can I customize the markdown preview CSS?
+Yes. Read [this](https://shd101wyy.github.io/markdown-preview-enhanced/#/customize-css) for more information.
+### Is there a list of keyboard shortcuts I can see?
+Dendron has a list of keyboard shortcuts that you can access using `Dendron: Show Help` command. Note that these only show the commands that come with the Dendron Plugin but not its bundled extensions. We currently have an open [issue](https://github.com/dendronhq/dendron/issues/148) to list all shortcuts on one page.
+### Why are there '+' signs next to the notes in the Tree View?
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/faq.plus-sign.jpg)
+The reason you see this is because Dendron will create [[stub|dendron.concepts#stubs]] notes when creating notes that have parents that don't exist. These notes are placeholders and will only be visible in the Dendron Tree View with a `+` sign next to the name. The reason we do stubs is because we don't want to litter your file system with empty files. Stubs are a compromise - they let you see the hierarchy of your newly created notes without forcing you to create intermediary files.
+### Why custom markdown preview instead of the VSC one?
+Our custom markdown preview gives us much more functionality then the vscode one -> eg. note references, checkboxes, etc.
+In addition, the markdown preview that Dendron uses is platform agnostic (eg. it's also available on atom). This means that other editors could potentially adopt it as well.
+### VSCode Snippets are not working in Frontmatter
+The default snippets are scoped to markdown. You can create [global snippets](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets) file to have snippets that work across all languages.
+### The extension 'Dendron Markdown Preview Enhanced' took a very long time to complete its last operation
+This is a known issue whenever we release a new version of the preview (mostly because its uncompressed javascript).  Moving forward, we'll be removing the dependency on an external plugin and integrating Dendron's markdown features into vscode's native markdown preview in the near future.

Added: vault/dendron.features.md

Files changed (1) hide show

vault/dendron.features.md +142 -0

vault/dendron.features.md ADDED Viewed

@@ -0,0 +1,142 @@
+---
+id: 4bb85c39-d8ac-48ad-a765-3f2a071f7bc9
+title: Features
+desc: ''
+updated: 1614612734259
+created: 1596320368075
+stub: false
+nav_order: 2
+---
+## Hierarchies
+Dendron proposes **hierarchies** as the **human solution** to information overload. This is because there are few things as effective as a multi-level hiearchy for quickly filtering an overwhelming amount of information to something humans can work with. You can read [this blog post](https://www.kevinslin.com/notes/e1455752-b052-4212-ac6e-cc054659f2bb.html) for the extended rationale behind this.
+In Dendron, you can quickly **lookup** related notes by their hierarchy. Hierarchies are simply `.` delimited filenames, similar to the hierarchies made by domain names (eg. `github.com`).
+The following are a few notes that have this hierarchical naming format.
+```
+- cli.tar.md
+- cli.tar.env.md
+- cli.curl.md
+- cli.dig.md
+```
+## Lookup
+**Lookup** is the process of finding a note by traversing its hierarchy.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup-cli.gif)
+> Lookups are **quick**
+What's nice about using the `.` delimited format is that a note **can be** both **a file** (something that contains data) and **a folder** (something that contains other files) **at the same time**.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup-folder_and_file.gif)
+> You **can** be a file and have your folder **too**
+Dendron uses fuzzy matching on paths so you don't have to type out the whole path.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup-fuzzy.gif)
+> Lazyness is the key to success
+You can use **lookup** to figure out what is true!
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup-bool.gif)
+## Schemas
+If you're paying close attention, you might have noticed some icons popup during lookup.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-closeup.jpg)
+These icons indicate the **schema** associated with the note. Think of schemas as an **optional type system** for your information. They describe the hierarchy of your notes and are themselves, represented as a hierarchy.
+You can create a schema by adding a YAML file with the following naming scheme `{name}.schema.yml` to your workspace.
+Below is an example of a three-level hierarchy describing cli commands. You don't need to concern yourself with the details of the schema syntax just yet, just know that this schema will match the following [glob patterns](https://facelessuser.github.io/wcmatch/glob/): `cli.*`, `cli.*.cmd`, `cli.*.cmd.*`, `cli.*.env`
+```yml
+- id: cli
+  desc: command line interface reference
+  parent: root
+  namespace: true
+  children:
+    - cmd
+    - env
+- id: env
+  desc: variables relevant for command
+- id: cmd
+  desc: subcommands
+  namespace: true
+```
+Schemas help you organize your notes by letting you know what comes next.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-suggest.gif)
+The `+` sign next to the suggestion indicates that the note does not exist but is part of the schema.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-plus.jpg)
+**Schema suggestions** don't show you an endless lineup of tags or folders - they only show you suggestions scoped to your specific level of the hierarchy that you are looking at.
+The nice thing about these suggestions is that you can also ignore them.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-ignore.gif)
+> Sometimes ~~rules~~ schemas are meant to be broken
+Dendron will show you a `?` next to the result in future results but otherwise will assume that you know best.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-question.jpg)
+## VS Code
+Dendron is built on top of VSCode, the open-source IDE from Microsoft.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/code-banner.jpg)
+Dendron runs as a plugin inside VSCode. If you use VSCode today, it means that all your current knowledge, settings and extensions will carry over into Dendron. If you don't, no sweat, because Dendron will create an optimal workspace with recommended settings and extensions when you first launch it.
+## Recommended Extensions
+Since Dendron runs on top of VSCode, it means that you also have access to thousands of extensions to customize Dendron exactly how you like it.
+By default, Dendron will initialize your first workspace with the following extensions and features.
+- [Markdown Notes](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes)
+  - [wiki links](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes)
+  - [tags](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes)
+  - [backlinks](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes) (think Roam)
+- [Markdown Shortcuts](https://marketplace.visualstudio.com/items?itemName=mdickin.markdown-shortcuts)
+  - Quickly toggle bullet points
+  - Easily generate URLs
+  - Convert tabular data to tables
+- [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced)
+  - [live markdown preview](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced)
+  - [math](https://shd101wyy.github.io/markdown-preview-enhanced/#/math) (KaTeX or MathJax)
+  - [sequence diagrams](https://shd101wyy.github.io/markdown-preview-enhanced/#/diagrams?id=mermaid) (mermaid)
+  - [pandoc support](https://shd101wyy.github.io/markdown-preview-enhanced/#/pandoc)
+  - [code chunks](https://shd101wyy.github.io/markdown-preview-enhanced/#/code-chunk)
+  - [presentations](https://rawgit.com/shd101wyy/markdown-preview-enhanced/master/docs/presentation-intro.html)
+- [Material Theme](https://marketplace.visualstudio.com/items?itemName=equinusocio.vsc-material-theme)
+  - beautiful colors built using the [Material design system](https://material.io/)
+- [Paste Image](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-paste-image)
+  - easily add images from your clipboard to your markdown files
+- [Spell Right](https://marketplace.visualstudio.com/items?itemName=ban.spellright)
+  - Spell Check
+## Additional Features
+The following extensions also work well with Dendron but are not bundled by default. You can download them separately to unlock additional functionality.
+- [Gitlens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens) 🔍
+  - Repository/File/Line history and annotations of all your files
+- [Vim](https://marketplace.visualstudio.com/items?itemName=vscodevim.vim)
+  - VIM key bindings 😍
+- [Bookmarks](https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks)
+  - Bookmark lines within files

Added: vault/dendron.guides.cook.md

Files changed (1) hide show

vault/dendron.guides.cook.md +313 -0

vault/dendron.guides.cook.md ADDED Viewed

@@ -0,0 +1,313 @@
+---
+id: 401c5889-20ae-4b3a-8468-269def4b4865
+title: Cookbook
+desc: ''
+updated: 1615132368125
+created: 1595952505024
+nav_order: 8.9
+toc: true
+---
+## General
+### Manual Install
+To manually install a custom version of Dendron, first obtain the Dendron vsix file (most likely, Kevin will send you a dropbox link 😅). Afterwards, you can install it by the extended options in the extensions pane.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/trouble.install.gif)
+### Checking Logs
+You can diagnose most problems by checking the logs. You can view the logs using the [[Open Logs Command|dendron.topic.commands#dendrondev-open-logs]]
+#### Server Logs
+Dendron has two sets of logs - client and server. The client logs you can access using the `Open Logs Command`. You can access the server logs by following the tutorial [here](https://www.loom.com/share/3d04cb1d6f904ac099d73e083e62ee2f).
+#### Logs from previous session
+Dendron has logs for the current session and the previous session.
+You can get logs of the previous session by following instructions [here](https://www.loom.com/share/2ca740e8e09b4aaf927d8098e2e6dec0)
+## Bucket
+### Star/Favorite/Pin Notes
+Dendron doesn't currently provide native support for this. You can download the [Bookmarks](https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks) extension to achieve the functionality in the interim.
+### Launch the command bar
+This lets you execute commands inside vscode
+- Linux: `Ctrl+Shift+P`
+- macOS: `Cmd+Shift+P`
+- Windows: `Ctrl+Shift+P`
+### Analyze notes using elasticsearch
+- WARNING: this is advanced material
+With Dendron, you can export your notes using the [[JSON Export Pod|dendron.topic.pod]] and then use that data to analyze your notes using elasticsearch.
+This video walkthrough walks you through that process.
+<a href="https://www.loom.com/share/c85c7c81d8aa4e97b4bbdf2245ca8f9b"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/c85c7c81d8aa4e97b4bbdf2245ca8f9b-with-play.gif"> </a>
+You can download the repo used in this walkthrough from [github](https://github.com/dendronhq/sample-elasticsearch-demo)
+Pre-requisites:
+- download and run elasticsearch
+Steps:
+1. Export your data using the JSON Export Pod
+2. Create an index in elasticsearch (we're using version 7.9)
+```json
+PUT notes
+{
+  "mappings": {
+    "properties": {
+      "created": {
+        "type":   "date",
+        "format": "epoch_millis"
+      }
+    }
+  }
+}
+```
+3. Pipe exported JSON into the newly created index.
+```bash
+cat /path/to/exported/notes.json | jq -c '.[] | {"index": {"_index": "notes", "notes", "_id": .id}}, .' | curl -H'Content-Type: application/json' -XPOST localhost:9200/_bulk --data-binary @-
+```
+4. Profit!
+Some potential use cases you can do using elasticsearch and Dendron:
+- filter your notes by any logical combination of custom attributes
+- make a heatmap of notes created by date
+- get a full list of tags used across your vault and on a per hierarchy basis
+- anything else you can thin of :)
+Some useful additional links:
+- [elasticsearch docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/elasticsearch-intro.html)
+- [elasticsearch vscode extension](https://marketplace.visualstudio.com/items?itemName=ria.elastic)
+### Convert timestamps in the frontmatter
+Currently, Dendron notes show timestamps in epoch time which is not the most parsable for humans. You can use the [timestamp converter extension](https://marketplace.visualstudio.com/items?itemName=Stalinbalraj.timestamp-converter) order to see a human representation of said timestamp.
+### Use Dendron with Anki
+- [Anki for VSCode](https://marketplace.visualstudio.com/items?itemName=jasew.anki)
+### Use Dendron on a separate instance of VS Code
+You can use Dendron on a separate instance of VS Code by launching it with the [command line flags](https://code.visualstudio.com/docs/editor/command-line#_advanced-cli-options) `--user-data-dir` and `--extensions-dir`:
+```
+code --user-data-dir=/path/to/code-dendron --extensions-dir=/path/to/code-dendron-ext
+```
+### Mobile Support
+Dendron does not have a dedicated mobile client at this time. There are numerous mobile markdown editors that can be used to view and edit Dendron notes. Some popular options are listed below:
+- [Git Journal](https://github.com/GitJournal/GitJournal)
+- [iA Writer](https://ia.net/writer)
+- [Epsilon Notes](https://play.google.com/store/apps/details?id=com.ekartoyev.enotes&hl=en_US&gl=US)
+- [Neutrinote](https://neutrinote.wordpress.com/) (Android only)
+Most mobile apps do not have git support.
+- If you are on iOS, you can follow the instructions [here](https://victoria.dev/blog/a-remote-sync-solution-for-ios-and-linux-git-and-working-copy/) to sync your git backed Dendron with any note taking tool on iOS.
+- If you are on Android, you can read [this writeup](https://mstempl.netlify.app/post/working-with-git-on-android/) by one of users on having Git Sync on Android devices
+### WebClipper
+You can use the [markdownload-markdown-web](https://chrome.google.com/webstore/detail/markdownload-markdown-web/pcmpcfapbekmbjjkdalcgopdkipoggdi) extension to clip content as markdown from Chrome.
+### Regex
+To get familiar with regex syntax, try [regexr](https://regexr.com/) is a great place to experiment with different queries.
+### Convert Local Vault to a Remote Vault
+1. Initialize local vault as a git repo and push it to a remote
+2. Remove the local vault from your current workspace
+3. Use the `Vault: Add` command and enter the remote url of the repo you would like to add
+### Automatically Convert Casing on a Note
+You can use the [string converter](https://marketplace.visualstudio.com/items?itemName=adamwalzer.string-converter) extension to change `[[normal note with spaces]]` to `[[normal-note-with-spaces]]` as well as a series of other text transformations.
+## Markdown Preview
+### Prevent newly opened files from replacing the preview pane?
+Set the following option in your workspace settings
+```json
+"markdown-preview-enhanced.automaticallyShowPreviewOfMarkdownBeingEdited": true,
+```
+### Customize Theme
+To change the color theme, you can update the `markdown-preview-enhanced.previewTheme` vscode setting
+### Customize CSS
+You can see instructions for customizing css [here](https://shd101wyy.github.io/markdown-preview-enhanced/#/customize-css)
+## VSCode
+### Use Dendron with a current folder
+- 1. start by initializing a workspace
+((ref:[[dendron.topic.commands]]#initialize workspace:#*))
+- 2. by default, dendron uses a `vaults` folder underneath your workspace to store you vaults. Update your [[settings|dendron.guides.settings]] and change `vault` to the path of your current notes (alternatively, you can also copy your current notes into `vault`)
+```
+"folders": [
+    {
+        "path": "vault"
+    },
+    ...
+],
+```
+- 3. Run `> Dendron: Reload Index` for Dendron to pick up changes
+### Access Dendron Workspace from multiple windows
+There are usually two scenarios:
+1. you want two windows of different workspaces
+2. you want two windows of the same workspace
+- for 1, create a new window and initialize a new workspace in some directory that is different from your first workspace
+- for 2, you have a few options
+  - a. initialize a new workspace in a different directory. open the settings using `> Open User Workspace settings (JSON)`. change the folder to the path of your vault in the initial workspace. run `> Reload Window` for the changes to take affect
+  - b. use a different version of vscode to open the same workspace (eg. vscode insider, vscodium, vscode regular). you need to do this because vscode will re-use the same window when opening the same workspace
+### Change the sorting order in the Outline Panel
+Click the three little dots next to outline to change the sorting order. You can sort by **Name** (alphabetical) or **Position** (linear order)
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/cook.vscode.outline.jpg)
+### Change the sorting oder in the Explorer Panel
+See instructions [here](https://stackoverflow.com/questions/51543871/sorting-files-in-vs-code-explorer)
+### Drag and Drop files into Dendron
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/cook.drag.jpg)
+To drag files into Dendron, open the workspace pane on the side to drag and drop. We currently recommend you only do this for non-markdown files that you want to link to inside your vaults.
+### Find Installed Extensions
+1. Navigate to the extensions pane
+1. Search for `@installed`
+## Navigation
+### Enable Table of Contents
+When viewing your notes locally, you can view the toc either from the outline view or by toggling the preview
+- from the outline
+  ((ref:[[dendron.topic.workbench]]#outline view,1:#*))
+- from the preview
+  ((ref:[[dendron.topic.preview]]#table of contents,1))
+## Publishing
+### Incremental Builds
+You can do incremental builds from Jekyll and Dendron
+- when previewing the site locally, add the `incremental` flag
+  ```bash
+  bundle exec jekyll s --watch --incremental
+  ```
+- when building the site, also add an incremental flag
+  - NOTE: you'll need `rsync` installed to use the incremental flag
+```bash
+dendron-cli buildSite --wsRoot {path/to/ws} --vault {path/to/vault} --incremental
+```
+### Automatically Update Site while editing
+The following instructions cover how to update your local preview everytime you make a change to your notes
+- install `dendron-cli`
+  ((ref:[[dendron.topic.cli]]#installation,1:#*))
+- have jekyll watch your site-root
+```bash
+cd {your-site-root}
+bundle exec jekyll s --watch
+```
+- use `nodemon` to watch your vault
+```bash
+npm install -g nodemon
+nodemon --watch {path/to/vault} --ext md dendron-cli buildSite --wsRoot {path/to/ws} --vault {path/to/vault}
+```
+- NOTE: you can combine this with incremental builds to have the best editing experience
+### Publish password protected site using AWS Amplify
+You can click [here](https://main.d19svbygngqnpb.amplifyapp.com/) to see a demo of the end result.
+You can access the site with username: `dendron`, password: `hierarchy`.
+- NOTE: this requires hosting your site on AWS. For most people, this will end up costing you a few cents a month.
+#### Setup your github repo
+1. Create a new github repo using this [template](https://github.com/dendronhq/dendron-amplify-template/generate).
+2. In your Dendron workspace, remove the `docs` directory and clone your newly created repository
+   ```bash
+   cd {your-workspace}
+   rm -r docs
+   git clone {your-repo} docs
+   ```
+#### Setup aws
+1. Create an [aws account](https://aws.amazon.com/)
+2. Login to your AWS account and go select the [Amplify Service](https://us-west-2.console.aws.amazon.com/amplify/home?region=us-west-2#/)
+   - ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/amplify.select.jpg)
+3. Follow the instructions [here](https://docs.aws.amazon.com/amplify/latest/userguide/getting-started.html) to connect your github with your amplify
+4. Follow the instructions [here](https://docs.aws.amazon.com/amplify/latest/userguide/access-control.html) to restrict access to your site.
+5. Verify that your site is now password protected
+#### Publish your notes
+1. Update `siteRepoDir` in `dendron.yml` with the location of your github directory
+   - Your `dendron.yml` should look similar to the one below
+     ```yml
+     site:
+         copyAssets: true
+         siteHierarchies:
+             - root
+         siteRootDir: docs
+         usePrettyRefs: true
+         siteRepoDir: docs
+     ```
+2. Run `> Dendron: Publish` to build your notes for publication and push your notes
+3. Your notes are now published privately behind a password

Added: vault/dendron.guides.install.md

Files changed (1) hide show

vault/dendron.guides.install.md +33 -0

vault/dendron.guides.install.md ADDED Viewed

@@ -0,0 +1,33 @@
+---
+id: d95b93bf-5e6f-4dd0-b7d7-c8e29e061876
+title: Getting Started
+desc: ''
+updated: 1608485512284
+created: 1595537796868
+---
+[Ed](https://www.youtube.com/channel/UCBDaEQKIAgU-U6bsUfPcWnA), our fellow Dendrologist, has made a fantastic getting started video to help folks install and setup Dendron.
+<iframe width="560" height="315" src="https://www.youtube.com/embed/BRLLZ9IEh10" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+# Install
+Dendron can be installed as a [vscode plugin](https://marketplace.visualstudio.com/items?itemName=dendron.dendron). If you don't already have VSCode, you can download it [here](https://code.visualstudio.com/).
+After you have downloaded the plugin, following the instructions to create your first **workspace**.
+1. With VSCode in focus, launch the _command bar_:
+((ref:[[dendron.guides.cook]]#launch the command bar,3:#*))
+2. Paste the following command and press `Enter`:
+```bash
+> Dendron: Initialize Workspace
+```
+3. Select a folder that will act as the root of your dendron workspace.
+![Initialize workspace](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/dendron-init.gif)
+When the workspace opens, it will show dialogue to install the recommended extensions. Though not required, these extensions add all the **non-core** features of Dendron like wiki links and tagging support.

Added: vault/dendron.guides.md

Files changed (1) hide show

vault/dendron.guides.md +10 -0

vault/dendron.guides.md ADDED Viewed

@@ -0,0 +1,10 @@
+---
+id: 02c2d7b6-2ea2-4e15-9894-9dead50d5ca2
+title: Guides
+desc: ''
+updated: 1604237878745
+created: 1604237852460
+nav_order: 7
+---
+Resources to help you with using Dendron.

Added: vault/dendron.guides.migration.md

Files changed (1) hide show

vault/dendron.guides.migration.md +29 -0

vault/dendron.guides.migration.md ADDED Viewed

@@ -0,0 +1,29 @@
+---
+id: f9b4fc21-7613-4c8a-9257-cec4c06b67f9
+title: Migration
+desc: ''
+updated: 1607277962381
+created: 1603982164242
+---
+This note covers migrating your notes from other tools
+## Obsidian
+1. Use the [[markdown pod|dendron.topic.pod.builtin.markdown]] to import your notes into Dendron
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/b2cb9672c6814ae5b149eae8e3fbca0b" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+## One Note
+1. [Convert one note files to markdown](https://itectec.com/superuser/how-to-export-all-onenote-pages-to-individual-markdown-files/)
+2. Use the [[markdown pod|dendron.topic.pod.builtin.markdown]] to import your notes into Dendron
+## Importing Files
+Once Dendron is initialized, to import an individual markdown file to your Dendron project.
+1. drag the markdown file into VSCode
+2. run `Dendron Doctor`so Dendron recognizes the imported file.
+The second step will add some front matter to the head of the file.

Added: vault/dendron.guides.settings.md

Files changed (1) hide show

vault/dendron.guides.settings.md +14 -0

vault/dendron.guides.settings.md ADDED Viewed

@@ -0,0 +1,14 @@
+---
+id: 26d66e84-6e4f-4688-bf6e-af070def7c38
+title: Settings
+desc: ''
+updated: 1604238328894
+created: 1600729806764
+---
+You can update Dendron settings by using the VSCode workspace settings by using the command prompt to `Preferences: Open Workspace Settings`
+<a href="https://www.loom.com/share/2d8eaeb6fddf4c76a390d3894b497435">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/2d8eaeb6fddf4c76a390d3894b497435-with-play.gif"> </a>
+If you are comfortable with editing raw JSON, you can use `Preferences: Open Workspace Settings (JSON)` to work with the settings in raw JSON

Added: vault/dendron.guides.tips.md

Files changed (1) hide show

vault/dendron.guides.tips.md +422 -0

vault/dendron.guides.tips.md ADDED Viewed

@@ -0,0 +1,422 @@
+---
+id: 692fa114-f798-467f-a0b9-3cccc327aa6f
+title: Tips
+desc: ''
+updated: 1612800748642
+created: 1595614204291
+---
+## Bucket
+### Peeking
+It is possible to [peek](https://code.visualstudio.com/docs/editor/editingevolved#_peek) at wiki-links in Dendron. This lets you see content without actually navigating to the page.
+<a href="https://www.loom.com/share/2289613674ac4a4183ed5db8630120dc">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/2289613674ac4a4183ed5db8630120dc-with-play.gif">
+</a>
+### Moving Lines
+When working with lines, you can move entire lines at a time using `option-up|down` shortcut on mac. This is really helpful for prioritizing todos among other things ✅
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips-move-lines.gif)
+### Search Editor
+- [docs](https://code.visualstudio.com/updates/v1_43#_search-editors)
+Also known as the coolest feature in vscode that most people have never heard of. This lets you view and save your search results in a full blown text editor. You can combine it with Dendron's hierarchies to do some amazing things, like aggregating all your todos.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.search-editor.gif)
+You can open search editor via keyboard shortcut. I use it to start a search with the current filename. works really well with Dendron hierarchies.
+```json
+  {
+    "key": "ctrl+s f",
+    "command": "search.action.openNewEditor",
+    "args": {
+      "query": "",
+      "triggerSearch": false,
+      "focusResults": false,
+      "includes": "${fileBasenameNoExtension}",
+    }the following line
+  }
+```
+### Stylized Tags Using Custom CSS
+To customize the look and feel of your tags, you can do so by using the following convention and [CSS edits](https://www.dendron.so/notes/683740e3-70ce-4a47-a1f4-1f140e80b558.html#can-i-customize-the-markdown-preview-css).
+Let's say you have a `books` hierarchy and you have a `books.high-growth-handbook` note. You have all the tags you use for books under a `books.tags.` namespace.
+If you use links for tags: `[[#business|books.tags.business]]`, you can use this CSS to customize their look:
+```css
+/* General tag styling */
+a[href*=".tags."] {
+    color: #000;
+    background: #fff;
+    display: inline-block;
+    padding: 0 10px;
+    border-radius: 4px;
+}
+/* Customizing the look of specific tags */
+a[href*=".tags.business"] {
+    color: #fff;
+    background: rgb(36, 89, 233);
+}
+```
+The result looks like this:
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.tags.png)
+### Collapsing Headers and Bullets
+You can collapse headers at different levels and bullets at different indentation levels inside VSCode.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.toggle-bullets.gif)
+### Create a new note in a deeply nested hierarchy
+- [discord thread](https://discordapp.com/channels/717965437182410783/735365126227493004/758235198403117087)
+- Problem:
+   - You are currently in `foo` and you want to create the note `foo.child1.child2.my-note`. You don't want to type out the full path. Is there an easier way to create `my-note` than typing out the full path?
+- Solution:
+  - VSCode doesn't support autocomplete inside the quick input widget which Dendron uses for lookups. We are experimenting with different ways of getting around this.
+  - Today, the workaround is to create a wiki-link inside another note and navigate via link to create it.
+  - Another method, if you know you will be creating multiple children under a single deeply nested parent, is to pin the parent and create the child from the parent
+<a href="https://www.loom.com/share/f0bbfc9cae0a474a99f8a1169b7b96c7">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/f0bbfc9cae0a474a99f8a1169b7b96c7-with-play.gif"> </a>
+### Automate Git Tasks
+- [discord thread](https://discordapp.com/channels/717965437182410783/742532267058004098/759130627781558403)
+- Problem:
+  - You want an easier way to `git add && git commit && git push`
+- Solution
+  - Use [git automator](https://marketplace.visualstudio.com/items?itemName=ivangabriele.vscode-git-add-and-commit).
+### Publish to GitHub Pages with Actions
+- [discord thread](https://discordapp.com/channels/717965437182410783/749641193322971238/759190468671438848)
+It's possible to publish your Dendron site to GitHub Pages without the shadow copy of your notes in the `docs` directory.
+You can create a GitHub Actions workflow to perform the export process using the Dendron CLI and push the result to your `pages` branch, triggering a Pages build.
+Note that this configuration won't retain any history on the `paths` branch. Paths below are relative to your workspace root.
+Ignore the shadow directories in `.gitignore`:
+```
+gitignore
+# Dendron
+/docs/assets/
+/docs/notes/
+/docs/_site/
+# npm
+/node_modules/
+```
+Create a `package.json` to install the package:
+```json
+{
+  "scripts": {
+    "dendron-cli": "dendron-cli"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/LukeCarrier/brain.git"
+  },
+  "license": "UNLICENSED",
+  "devDependencies": {
+    "@dendronhq/dendron-cli": "^0.12.3-alpha.16"
+  }
+}
+```
+Create the workflow `.github/workflows/dendron.yml`:
+```yaml
+name: Dendron
+on:
+  push:
+    branches:
+    - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v2
+    - name: Install npm dependencies
+      run: npm install
+    - name: Build pod
+      run: npm run dendron-cli -- buildSite --wsRoot ./ --vault notes/
+    - name: Deploy site
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_branch: pages
+        publish_dir: docs/
+        force_orphan: true
+        enable_jekyll: true
+```
+Configure your repository's Pages settings as follows:
+* _Branch_: `pages`
+* _Folder_: _/ (root)_
+Finally, commit these three files and push them to your `master` branch. Within a few seconds you should see the workflow run, your `pages` branch get updated and your Pages build start.
+### Go back to previous Note
+Use "> Quick Open Previous Recently Used...` to navigate through recently opened notes
+  - default shortcut: `CTRL-TAB`
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.tabs.most-recent.gif)
+### Keep Track of Tabs
+It's really easy to lose sight of your tabs, especially with menu items occluding the little horizontal space you have for tabs.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.tabs.nav.jpg)
+Instead of relying on the menu, you can use `Show All Editors` to see all tabs via a dropdown. You can also narrow down tabs after selection.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.tabs.editors.gif)
+You can streamline this process by assigning a keyboard shortcut to the command. Below is an example.
+  ```json
+  {
+    "key": "ctrl+t",
+    "command": "workbench.action.showAllEditors"
+  }
+  ```
+### Copy and Paste Web Content into Dendron
+First copy it into Notion or use the notion web clipper to clip it. This will format it nicely in markdown. You can then paste it into Dendron with markdown and everything :)
+<!--
+### Custom Outlines
+TODO: need to add more details
+Outlines are super helpful but there are not always feasible depending on the file format
+![](/assets/images/2020-09-21-19-33-21.png)
+In those situations, I like to leave markers inside a note and use the search editor to surface those markers
+<a href="https://www.loom.com/share/eabf90dbc74e4a1facd5e82bd76a6134">
+<p>Tips - Breadcrumbs - Watch Video</p>
+<img style="max-width:300px;" src="https://cdn.loom.com/sessions/thumbnails/eabf90dbc74e4a1facd5e82bd76a6134-with-play.gif"> </a>
+https://www.loom.com/share/eabf90dbc74e4a1facd5e82bd76a6134
+You can use the same technique
+# Generating all journal notes ahead of time
+https://stackoverflow.com/questions/25701265/how-to-generate-a-list-of-all-dates-in-a-range-using-the-tools-available-in-bash
+-->
+## Workbench
+### Navigating a hierarchy
+One easy way of navigating hierarchies it to click on the file name. This will reveal a dropdown that shows you all siblings of the current note.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/guide.siblings.jpg)
+### Remove Markdown Buttons in Menu Bar
+- [discord thread](https://discordapp.com/channels/717965437182410783/739186036495876126/758408534848831558)
+```json
+"markdownShortcuts.icons.bold": false,
+"markdownShortcuts.icons.italic": false,
+"markdownShortcuts.icons.strikethrough": false,
+"markdownShortcuts.icons.bullets": false,
+```
+### Moving Panes
+You can move vscode tabs using the following builtin commands:
+- `View: Move Editor Into Next Group`
+- `View: Move Editor Into Previous Group`
+They are mapped on to the following keyboard shortcuts:
+- mac: `cmd+ctrl+left|right`
+This is helpful for looking at your notes side by side.
+<a href="https://www.loom.com/share/d99ec9cce8ff4d869cf8c36955152808">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/d99ec9cce8ff4d869cf8c36955152808-with-play.gif"> </a>
+### Pinning Tabs
+You can pin tabs in VSCode by right clicking on a tab and selecting `Pin Tab`.
+The latest VSCode lets you control pin behavior for tabs. It's not currently documented as of 2020.09.28 but as of the latest insider build, it has a few different options to control the pinned behavior.
+- options:
+  - normal (default), normal tab size with a pin icon
+  - shrink: reduced tab size with some text visible
+  - compact: only icon visible
+```json
+"workbench.editor.pinnedTabSizing": "shrink"
+```
+### Zen Mode
+VSCode can be visually noisy. You can hide most of the UI by toggling `Zen Mode` with a three panel layout.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tips.zen.jpg)
+The following setting overrides are useful:
+```json
+// by default, zen mode will open a new "workspace" which I don't like
+"zenMode.fullScreen": false,
+// I'm a vim user so I like my line numbers
+"zenMode.hideLineNumbers": false,
+```
+To navigate tabs and look at the breadcrumb outline, You can use the following commands
+```json
+workbench.action.showAllEditors -> (no shortcut by default, consider mapping to ctrl + t)
+breadcrumbs.focusAndSelect -> cmd + t
+```
+You can see a video of this workflow in the video below.
+<a href="https://www.loom.com/share/dd27df6d556d4ba6b28b2028ca7d1455">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/dd27df6d556d4ba6b28b2028ca7d1455-with-play.gif"> </a>
+### Always show preview of md being edited
+Set the following option in your workspace settings
+```json
+"markdown-preview-enhanced.automaticallyShowPreviewOfMarkdownBeingEdited": true,
+```
+## Snippets
+### Have links auto-complete without additional key presses
+- Update your settings to the following
+```json
+// The following settings will only apply to markdown files:
+  "[markdown]": {
+    // quickSuggestions true will provide suggestions as you type.
+    // If you turn this on and DO NOT want suggestions
+    // for non-wiki-link, non-tag words,
+    "editor.quickSuggestions": true,
+    // This is poorly documented, but seems to offer suggestions
+    // from any word in open document when turned on, which
+    // can be a little distracting in markdown docs:
+    "editor.wordBasedSuggestions": false,
+    "editor.tabSize": 2,
+    // Set this to false if you turn on quickSuggestions
+    // but don't want suggestions for markdown related snippets
+    // as you type:
+    "editor.suggest.showSnippets": false,
+  },
+```
+## Markdown
+### Always have the preview open
+You can add the following setting to your workspace to always have a markdown editor show up with your content.
+```json
+"markdown-preview-enhanced.automaticallyShowPreviewOfMarkdownBeingEdited": true,
+```
+### Symbol search
+When using the standard file-search in vscode (`ctrl-P`), you can search for all titles in your workspace if you use the starting keyword `#`
+Example: if i know i had a header with the title "cheatsheet", i can type in `# cheatsheet`
+### Auto bullet list
+VSCode doesn't support auto-formatting by default. You can use the following workaround to mimic the behavior.
+- Add list-item below current position. Using `-`
+```json
+{
+        "key": "shift+enter",
+        "command": "type",
+        "args": {
+            "text": "\r\n- "
+        },
+        "when": "editorTextFocus && !editorReadOnly && editorLangId == 'markdown'"
+}
+```
+- Add list-item below current position. Using `*`
+```json
+{
+        "key": "shift+enter",
+        "command": "type",
+        "args": {
+            "text": "\r\n* "
+        },
+        "when": "editorTextFocus && !editorReadOnly && editorLangId == 'markdown'"
+}
+```
+> Credit for this recipe goes to @Stigs#0135
+## Other Tools
+This is a list of other tools that work well with Dendron.
+- [nvAlt](https://brettterpstra.com/projects/nvalt/): local markdown editor that works well with Dendron notes (mac only)
+## Other VSCode Extensions
+### Git
+- [Git Automator](https://marketplace.visualstudio.com/items?itemName=ivangabriele.vscode-git-add-and-commit): one command to commit and push all changes
+- [Git Doc](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.gitdoc): auto-commit and (optionally) auto push your notes at fixed intervals
+- [Gitlens](https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens): Repository/File/Line history and annotations of all your files
+- [Path AutoComplete](https://github.com/ionutvmi/path-autocomplete): Path autocomplete for VSCode
+### Other
+- [Macros](https://marketplace.visualstudio.com/items?itemName=geddski.macros): Define custom macros
+- [Vim](https://marketplace.visualstudio.com/items?itemName=vscodevim.vim): VIM key bindings 😍
+- [Bookmarks](https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks): Bookmark lines within File [Vertical Limit](https://marketplace.visualstudio.com/items?itemName=generik.vertical-limit): Work with multiple cursors and blocks of text
+- [CodeUI](https://marketplace.visualstudio.com/items?itemName=ryanraposo.codeui): Easier customization of every part of the VSCode UI
+## Other Browser Extensions
+### Web Clipper
+- [Markdown Web](https://chrome.google.com/webstore/detail/markdownload-markdown-web/pcmpcfapbekmbjjkdalcgopdkipoggdi?hl=en-GB): markdown based web clipper
+- [Roam Highlighter](https://chrome.google.com/webstore/detail/mcoimieglmhdjdoplhpcmifgplkbfibp)

Added: vault/dendron.guides.troubleshooting.md

Files changed (1) hide show

vault/dendron.guides.troubleshooting.md +147 -0

vault/dendron.guides.troubleshooting.md ADDED Viewed

@@ -0,0 +1,147 @@
+---
+id: a6c03f9b-8959-4d67-8394-4d204ab69bfe
+title: Troubleshooting
+desc: ''
+updated: 1615132375354
+created: 1595952505025
+---
+## Diagnosing
+You can get a better idea of what went wrong by checking out the [[logs|dendron.guides.cook#checking-logs]]. At that point, you should be able to narrow down the root cause to one of the issues below. If not, please bring it up on the [discord](https://discord.gg/AE3NRw9) or file a [bug report](https://github.com/dendronhq/dendron/issues/new?assignees=&labels=&template=bug_report.md&title=)
+## General
+### Engine not initialized
+This is most likely due to the VSCode [workspace file](https://code.visualstudio.com/docs/editor/multi-root-workspaces#_opening-workspace-files) not being open. Make sure to open the **dendron.code-workspace** file by following the instructions [here](https://code.visualstudio.com/docs/editor/multi-root-workspaces#_opening-workspace-files)
+### Multiple Vaults with the same name
+You will get this if you have multiple [[vaults|dendron.topic.config#vaults]] that have the same name. This is an error with Dendron since Dendron requires all vault names be unique. You can fix this by removing the duplicate vaults or setting a unique [[name|dendron.topic.config#name]] property for the vault.
+### Notes from the graph/tree view are out of sync
+Run `Dendron: Reload Index` to manually sync. If that doesn't work, you can also try `Developer: Reload Window` to restart VSCode.
+## Upgrading
+### Error upgrading
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/trouble.upgrade.png)
+Dendron will update keybindings/settings/etc to the latest defaults if not currently set on upgrade. If you see the above error, it means that Dendron had trouble parsing one of your settings files. This doesn't stop dendron from starting but it does mean that the latest settings aren't being applied.
+The most likely culprit of this error is a bad snippets file. To fix, bring up the command prompt, type `>Configure User Snippets`, open `dendron.code-snippets` and see if there's anything funky with the json on the line mentioned by the error. You can also use tools like [jsonlint](https://jsonlint.com/) to validate your JSON.
+## Schemas
+### I'm getting a `you cannot define a mapping item when in a sequence` when trying to define a schema
+That means there's an issue with your yaml. You can paste it in [yaml lint](http://www.yamllint.com/) to check that you are using the correct yaml syntax.
+### Schema Templates aren't working
+Schema templates are defined as YAML objects. The most common mistake is putting them down as a list
+For example, this is a valid schema.
+```yml
+- id: journal
+  title: journal
+  desc: ""
+  parent: root
+  children:
+    - daily
+- id : daily
+  namespace: true
+  template:
+    id: journal.template.daily
+    type: note
+```
+This is not a valid schema.
+```yml
+- id: journal
+  title: journal
+  desc: ""
+  parent: root
+  children:
+    - daily
+- id : daily
+  namespace: true
+  template:
+    - id: journal.template.daily
+      type: note
+```
+## Markdown Preview
+### Why can't I click the checkbox?
+It could be that you are using the VSCode default markdown instead of Dendron's Markdown Preview.
+They both have identical icons and its currently not possible to disable the builtin preview (we are looking into fixing this [here](https://github.com/dendronhq/dendron/issues/42)).
+Meanwhile, you can open Dendron's markdown preview by clicking the preview button on the left of the menu bar or by using the `> Markdown Preview Enhanced: Open Preview to the Side` command
+![Markdown preview](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/trouble-md.png)
+### Still initializing.  Please close this window and try again after Dendron has been initialized.
+When Dendron starts up, it initializes a local server which is responsible for indexing notes and fetching note metadata. Plugins like the preview depend on the server being initialized before activating. You'll know the server is initialized after you see a `Dendron is activated` notification.
+## Linux
+### Reference to Another Note on Ubuntu
+If Ctrl+Shift+R (reference to another note) doesn't work on Ubuntu, do `sudo apt install xsel`.
+## Publishing
+### Can't open local preview
+Dendron runs the preview on port 8080. Make sure you don't have something already running there.
+- windows
+```powershell
+# get ids of processes
+Get-Process -Id (Get-NetTCPConnection -LocalPort 8080).OwningProcess
+# if you see any result, you can stop them using the following command
+Stop-process -Id {IDS_FROM_ABOVE}
+```
+- linux
+```bash
+# get ids
+lsof -l -n -P -i tcp:8080
+# kill
+kill -9 {IDS}
+```
+## Etc
+### Error: spawn git ENOENT
+Check if you have git installed. You can find more details [here](https://stackoverflow.com/questions/42545885/vs-code-error-spawn-git-enoent)
+### Clicking on the link creates multiple files
+This is likely due to other extensions that you have installed that provide conflicting definitions for [[wiki links|dendron.topic.links#wiki-links]].
+The most likely culprits are `foam` or `markdown-notes`. Uninstalling them will fix this issue.
+You can see your installed
+## Send a support request
+If none of the troubleshooting methods work, you can ping kevin on Discord or submit a github issue.
+When doing either of these things, please include the following information:
+- [[Plugin Logs|dendron.guides.cook#checking-logs]]
+- [[Server Logs|dendron.guides.cook#server-logs]]
+- Contents of your [[workspace settings|dendron.guides.settings]]
+- Contents of [[dendron.yml|dendron.topic.commands#configure-yaml]]

Added: vault/dendron.guides.uninstall.md

Files changed (1) hide show

vault/dendron.guides.uninstall.md +15 -0

vault/dendron.guides.uninstall.md ADDED Viewed

@@ -0,0 +1,15 @@
+---
+id: e45dc24b-b673-4144-a905-4a1c88378e28
+title: Uninstall
+desc: ''
+updated: 1607889337490
+created: 1607889245545
+---
+To uninstall Dendron, uninstall the following extensions in order.
+1. Dendron Markdown Links
+2. Dendron Markdown Preview Enhanced
+3. Dendron
+NOTE: The reason for this is because markdown links & markdown preview both declare a dependency on dendron extension. This dependency exists because we have an ordering requirement (dendron needs to start first and initialize the engine and the extensions connect to it) Vscode prevents you from uninstalling an extension that has active dependents, hence the sequence above.

Added: vault/dendron.guides.upgrading.md

Files changed (1) hide show

vault/dendron.guides.upgrading.md +32 -0

vault/dendron.guides.upgrading.md ADDED Viewed

@@ -0,0 +1,32 @@
+---
+id: 21c1288a-6fb8-42f5-90c0-9b3cc7d872ad
+title: Upgrading
+desc: ''
+updated: 1610601370405
+created: 1595010631247
+stub: false
+nav_order: 1.2
+---
+VSCode auto updates outdated extensions periodically but if you want to trigger it manually, you can click the extensions tab and look for dendron. If there's an update available, it will be done at this point.
+<a href="https://www.loom.com/share/796a10cab7204733877e7f708b6aaaca">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/796a10cab7204733877e7f708b6aaaca-with-play.gif">
+</a>
+To check what version of dendron you're on, you can open the lookup bar and look for the version number in the title.
+## Bundled Extensions
+Upgrading a recommended extension goes through the same process as upgrading dendron. It should happen automatically but you can manually trigger it by looking for the extension by name in the extension tab.
+You can find the list of all bundled extensions [[here|dendron.topic.extensions]].
+## Dendron CLI and Dendron 11ty
+To upgrade the CLI and 11ty, you need to manually run the following commands in your workspace:
+```
+npm install --save @dendronhq/dendron-cli@latest
+npm install --save @dendronhq/dendron-11ty@latest
+```

Added: vault/dendron.journal.2021.02.20.md

Files changed (1) hide show

vault/dendron.journal.2021.02.20.md +9 -0

vault/dendron.journal.2021.02.20.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: 68936a69-c876-4647-bfd3-1f95fe0cee19
+title: '20'
+desc: ''
+updated: 1613844220407
+created: 1613844220407
+stub: true
+---

Added: vault/dendron.journal.2021.02.20.migration.md

Files changed (1) hide show

vault/dendron.journal.2021.02.20.migration.md +27 -0

vault/dendron.journal.2021.02.20.migration.md ADDED Viewed

@@ -0,0 +1,27 @@
+---
+id: acd429ee-c458-421d-a087-ea0da07b64e0
+title: Migration
+desc: ''
+updated: 1613844174407
+created: 1613844030110
+---
+## Workspace Upgrade
+We recently ( 2021.02.13 ) upgraded Dendron's backend to use [Yarn Workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).
+This comes with a bunch of [[performance and size improvements|dendron.release.changelog#house-cleaning]] when developing Dendron.
+If you currently have Dendron checked out, you'll need to run the following commands to migrate over to using the yarn build method.
+```sh
+# get latest version
+git pull
+npm install -g yarn
+# remove old node_modules
+./bootstrap/scripts/cleanup.sh
+yarn bootstrap:bootstrap
+yarn bootstrap:build
+```

Added: vault/dendron.journal.2021.02.md

Files changed (1) hide show

vault/dendron.journal.2021.02.md +9 -0

vault/dendron.journal.2021.02.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: 67f35b15-a617-4ba6-9e53-d111ded53456
+title: '02'
+desc: ''
+updated: 1613844220407
+created: 1613844220407
+stub: true
+---

Added: vault/dendron.journal.2021.md

Files changed (1) hide show

vault/dendron.journal.2021.md +9 -0

vault/dendron.journal.2021.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: ec5c992b-a6c5-42df-9da8-7c6f324095b0
+title: '2021'
+desc: ''
+updated: 1613844220407
+created: 1613844220407
+stub: true
+---

Added: vault/dendron.journal.md

Files changed (1) hide show

vault/dendron.journal.md +9 -0

vault/dendron.journal.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: 923d1bad-74fa-4aff-bac3-9e1792db886f
+title: Journal
+desc: ''
+updated: 1614538417713
+created: 1614310670438
+nav_exclude: true
+---

Added: vault/dendron.md

Files changed (1) hide show

vault/dendron.md +96 -0

vault/dendron.md ADDED Viewed

@@ -0,0 +1,96 @@
+---
+id: b0fe6ef7-1553-4280-bc45-a71824c2ce36
+title: Dendron
+desc: ''
+updated: 1608840612657
+created: 1595952505017
+stub: false
+---
+<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
+<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
+<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
+<!-- ![](https://travis-ci.com/dendronhq/dendron.svg?branch=master) -->
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/logo-256.png)
+The **hierarchical** note taking tool that **grows** as you do!
+Dendron is an **open-source, local-first, markdown-based, note-taking tool** built on top of [VSCode](https://code.visualstudio.com/). Like most such tools,  Dendron supports all the usual features you would expect like tagging, backlinks, a graph view, split panes, and so forth. But it doesn't stop there - whereas most tools (try to make it) easy to **get notes in**, they tend to make it **hard to get them back out** later, and it only **gets worse as you add more notes**. Dendron helps you **get notes back out** and **works better** the **more notes you have**.
+I originally created Dendron because I'd accumulated over **20k notes** on programming and various other topics and couldn't find a tool that would let me easily add and find notes from within my knowledge base.
+Traditional note-taking tools are often **too rigid** by having an in-flexible hierarchy that doesn't let you file a note in multiple places. Newer tools are **too flexible** by eschewing hierarchies altogether in favour of relying solely on backlinks.
+Dendron finds the **usable center** between the two extremes by supporting backlinks of any two arbitrary notes while also maintaining a **canonical hierarchy** for every note. We do this through our **[hierarchal first approach to note taking](https://www.kevinslin.com/notes/3dd58f62-fee5-4f93-b9f1-b0f0f59a9b64.html)** that relies on the combination of [[hierarchies|dendron.topic.hierarchies]], [[schemas|dendron.topic.schema]], and [[path based lookups|dendron.topic.lookup]].
+With Dendron, you can **create, find, and collaborate** on information that **matters to you**.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/graph-intro.gif)
+## Use Cases
+Whether you organize your notes with [PARA](https://fortelabs.co/blog/para/) or [Zettelkasten](https://zettelkasten.de/), link notes together like [Roam](https://roamresearch.com/), or simply create notes in an ad-hoc manner, Dendron can help.
+Think of it as a [second brain](https://www.buildingasecondbrain.com/) to help you **make sense** of all the information you care about.
+Some popular use cases include:
+- project management
+- learning & academia
+- personal knowledge base
+- journaling of all forms
+- CRM to keep track of clients, friends and enemies
+- {Your Use Case Here}
+## Getting Started
+((ref:[[dendron.guides.install]]#Getting Started,1:#Install))
+## Onboarding
+[Kevin](https://kevinslin.com/), the founder of Dendron, does a personal onboarding with new users. This onboarding is customized to your note taking goals and familiarity with Dendron. You can see an example onboarding below and book your own [here](https://calendly.com/thence/dendron).
+<iframe width="560" height="315" src="https://www.youtube.com/embed/3io2fHRmZsE" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+You can find a rough transcript of this onboarding [[here|dendron.ref.transcript]] for reference (thank you Tom Diaz for providing the transcript).
+## Join Us
+<iframe src="https://ghbtns.com/github-btn.html?user=dendronhq&repo=dendron&type=star&count=true&size=large" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>
+To stay up to date on Dendron developments and all things knowledge management, you can follow us at [@dendronhq](https://twitter.com/dendronhq) or join us on [discord](https://discord.gg/AE3NRw9)!
+## Features
+See our core [[features|dendron.features]] that help you manage your notes.
+## Getting Started
+To get started, you can follow the instructions in [[quickstart|dendron.quickstart]].
+## Motivation
+> "We are overwhelmed with information and we don't have the tools to properly index and filter through it. [The development of these tools, which] will give society access to and command over the inherited knowledge of the ages [should] be the first objective of our scientist" - Vannevar Bush, 1945
+## You Are Here
+This project is about 1% complete, both in the sense that it is in **preview** but also that there's so much more to build. The north star of this project is to achieve _Vannevar Bush's_ original vision - to build a tool of thought that can give humanity _"**access to** and **command over** the inherited **knowledge of the ages**"_.
+If you are reading this, you too, are now part of the journey. Let's take back control of our information and use it to build something better, together!
+## FAQ
+See the [[FAQ|dendron.faq]] for answers for common questions.
+## Contributing
+We welcome community contributions and pull requests. See [CONTRIBUTING](https://github.com/dendronhq/dendron/blob/master/docs/CONTRIBUTING.md) for information on how to set up a development environment and submit code.
+## License
+Dendron is distributed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3.
+See [LICENSE](https://github.com/dendronhq/dendron/blob/master/LICENSE.md) and [NOTICE](https://github.com/dendronhq/dendron/blob/master/NOTICE.md) for more information.

Added: vault/dendron.mission-statement.md

Files changed (1) hide show

vault/dendron.mission-statement.md +10 -0

vault/dendron.mission-statement.md ADDED Viewed

@@ -0,0 +1,10 @@
+---
+id: 3bf95ba0-8d6e-4bfc-b46e-c0c66cdab2ee
+title: Mission Statement
+desc: ''
+updated: 1608575363983
+created: 1602262532844
+nav_exclude: true
+---
+Dendron helps people create, reference, and collaborate on the information they care about.

Added: vault/dendron.principles.md

Files changed (1) hide show

vault/dendron.principles.md +68 -0

vault/dendron.principles.md ADDED Viewed

@@ -0,0 +1,68 @@
+---
+id: 7fcebd7d-6411-4c9d-8baf-65629dc018a1
+title: Principles
+desc: ''
+updated: 1605042559429
+created: 1600440828180
+stub: false
+nav_order: 1.3
+---
+## Product
+### Speed
+Dendron should be the fastest way for **people** to access the information they care about.
+- lookup should finish in under a second
+- all parts of our toolchain should optimize for speed
+### Scale
+Dendron should become easier to use as you accumulate more notes.
+### Ownership
+Users should have **full control** of their data and it should be our first principle to maximize this as much as possible.
+### Interoperability
+It should be possible to import/export your data from/to any other source where a user might want to use their information.
+### Easy to learn, hard to master
+- see [Bushnell's Law
+  ](https://en.wikipedia.org/wiki/Bushnell%27s_Law#:~:text=Bushnell's%20Law%20or%20Nolan's%20Law,first%20quarter%20and%20the%20hundredth.)
+## Community
+### Open and Inclusive
+Dendron is a tool for **all users** that are interested in creating, building, using, and sharing knowledge. full stop.
+### Have it in writing
+We don't just share what we learn in a chat at a moment in time. We make sure that the information remains accessible longer after we are gone.
+# Tradeoffs
+You can't have something that is everything for everyone. There are tradeoffs we are making in Dendron.
+### Function over Form
+- in Dendron, it's more important for something to be useful than it is to be beautiful
+- the focus in Dendron should be about your content and the hierarchies that connect them
+### Focus on Hierarchies
+- while Dendron supports backlinks and other forms of organizing notes, Dendron's foundation is tooling to help you manage hierarchies
+### Focus on Speed
+- we can't predict the future but it's likely that no one will ever say that they wish their note taking experience to be slower
+- when thinking about features and tool chain, bias for speed
+### Retrieval over Insertion
+- all note taking tools focus on putting notes in but they struggle with helping users get notes back out, especially as users accumulate a lot of notes
+- Dendron takes the long view that you will read your notes far more than you write and optimize for getting notes back out

Added: vault/dendron.pro.dendron-11ty.install.md

Files changed (1) hide show

vault/dendron.pro.dendron-11ty.install.md +8 -0

vault/dendron.pro.dendron-11ty.install.md ADDED Viewed

@@ -0,0 +1,8 @@
+---
+id: 9ad8ae37-9f32-4043-b3f9-b36799a62bf0
+title: Install
+desc: ''
+updated: 1613096860430
+created: 1613096860430
+---

Added: vault/dendron.pro.dendron-11ty.internal.md

Files changed (1) hide show

vault/dendron.pro.dendron-11ty.internal.md +36 -0

vault/dendron.pro.dendron-11ty.internal.md ADDED Viewed

@@ -0,0 +1,36 @@
+---
+id: aa6009e6-db3d-44d8-bc60-723f03c048f7
+title: Internal
+desc: ''
+updated: 1613752914594
+created: 1612974783445
+---
+## Videos
+- [11ty and markdown parsing: I](https://youtu.be/3qWjBh3A55s)
+- [11ty and markdown parsing: II](https://youtu.be/5VJw102iosE)
+- [11ty and markdown parsing: III](https://youtu.be/E5erv3GawAc)
+## Generate notes
+- _includes/includes/note.liquid
+    - notesOnly
+- _data/notesOnly.js
+```ts
+return SiteUtils.filterByConfig({ engine, config })
+```
+## Rendering Notes
+- libs/shortcodes.js
+```ts
+toMarkdown2 {
+    procFull {
+        const engine = await getEngine();
+        ...
+    }
+}
+```

Added: vault/dendron.pro.dendron-11ty.md

Files changed (1) hide show

vault/dendron.pro.dendron-11ty.md +23 -0

vault/dendron.pro.dendron-11ty.md ADDED Viewed

@@ -0,0 +1,23 @@
+---
+id: 53dd4b9b-d3a7-4398-9511-b7a281039f9d
+title: Dendron-11ty
+desc: ''
+updated: 1611515672976
+created: 1608181727204
+---
+## Repo
+- https://github.com/dendronhq/dendron-11ty
+## Cook
+- check all notes that are published
+```bash
+cat /tmp/notes.log | jq '[. | to_entries[] | .value ] | .[].fname'
+```
+- check all published notes using search-data
+```bash
+cat assets/js/search-data.json | jq '.[].hpath'
+```

Added: vault/dendron.pro.dendron-11ty.qa.md

Files changed (1) hide show

vault/dendron.pro.dendron-11ty.qa.md +24 -0

vault/dendron.pro.dendron-11ty.qa.md ADDED Viewed

@@ -0,0 +1,24 @@
+---
+id: feb740f8-0d7b-4bc6-83bb-85886fe779f6
+title: Qa
+desc: ''
+updated: 1612908712863
+created: 1612903299090
+---
+## Test with a single file
+- update the `dendron.yml` file
+```yml
+...
+site:
+    siteHierarchies:
+        - foobar
+```
+- start the dendron workspace
+- create `foobar.md` with the frontmatter
+- add whatever syntax you want to test
+- run the CLI
+![[dendron.pro.dendron-11ty.quickstart#start-the-server-in-preview,1:#*]]

Added: vault/dendron.pro.dendron-11ty.quickstart.md

Files changed (1) hide show

vault/dendron.pro.dendron-11ty.quickstart.md +30 -0

vault/dendron.pro.dendron-11ty.quickstart.md ADDED Viewed

@@ -0,0 +1,30 @@
+---
+id: 132698b3-cfe0-457f-b7d6-7ddba5cfe096
+title: Quickstart
+desc: getting started with a project
+updated: 1611515835789
+created: 1611515667674
+---
+### Install dendron-11ty
+```bash
+yarn init
+npm install @dendronhq/dendron-cli@latest
+npm install @dendronhq/dendron-11ty@latest
+```
+### Start the server in preview
+- cd to your [[workspace root|dendron.concepts#workspace]]
+```bash
+cd {workspace root}
+npx dendron-cli buildSiteV2 --wsRoot .  --stage dev --serve
+```
+### Build notes for production
+```bash
+npx dendron-cli buildSiteV2 --wsRoot .  --stage prod
+```

Added: vault/dendron.pro.dendron-11ty.setup.md

Files changed (1) hide show

vault/dendron.pro.dendron-11ty.setup.md +57 -0

vault/dendron.pro.dendron-11ty.setup.md ADDED Viewed

@@ -0,0 +1,57 @@
+---
+id: 6f3bc07c-5232-4148-a42f-bac9c2fe12f6
+title: Setup
+desc: ''
+updated: 1612903363450
+created: 1611515613711
+---
+## Getting started
+### 1. Requirements
+![[dendron.dev.setup#1-requirements,1:#*]]
+### 2. Clone and Install
+```bash
+git clone https://github.com/dendronhq/dendron-11ty
+cd dendron-11ty
+npm install
+```
+### 3. Run 11ty
+![[dendron.pro.dendron-11ty.quickstart#start-the-server-in-preview]]
+## Running with dendron monorepo
+Dendron depends on a bunch of packages from the dendron monorepo. If you already have it installed and are working on monorepo components, you can link those components with 11ty to have live updates.
+### 1. Setup Monorepo
+- see instructions [[here|dendron.dev.setup]]
+### 2. Create links to the monorepo packages
+Run `yarn link` inside the following packages
+* @dendronhq/engine-server
+* @dendronhq/common-server
+* @dendronhq/common-all
+### 3. Link monorepo to 11ty
+Inside dendron-11ty, execute `./scripts/link.sh` file
+- NOTE: don't forget to watch the monorepo to compile changes
+![[dendron.dev.setup#watch-monorepo,1:#*]]
+### 4. Run Dendron Cli
+You can run this CLI on any valid workspace. There's a test workspace in `dendron-11ty` that is good to test against
+```sh
+cd dendron-11ty/fixtures/test-workspace
+```
+![[dendron.pro.dendron-11ty.quickstart#start-the-server-in-preview,1:#*]]

Added: vault/dendron.pro.dendron-api-server.internal.md

Files changed (1) hide show

vault/dendron.pro.dendron-api-server.internal.md +19 -0

vault/dendron.pro.dendron-api-server.internal.md ADDED Viewed

@@ -0,0 +1,19 @@
+---
+id: 767852dd-8e11-4e17-a68d-ae3e73811b1c
+title: Internal
+desc: ''
+updated: 1610144264886
+created: 1610144200281
+---
+# Launch
+- file: src/index.ts
+```ts
+launch {
+    appModule = require("./Server")
+    ...
+}
+```

Added: vault/dendron.pro.dendron-api-server.md

Files changed (1) hide show

vault/dendron.pro.dendron-api-server.md +23 -0

vault/dendron.pro.dendron-api-server.md ADDED Viewed

@@ -0,0 +1,23 @@
+---
+id: 554d3c62-29da-4c86-9d16-f910e36ad7b1
+title: Ops
+desc: ''
+updated: 1610144187255
+created: 1606628243560
+---
+### Initialize a workspace
+- NOTE: specific to kevin's vault, modify for your own
+```bash
+curl --location --request POST 'http://localhost:3005/api/workspace/initialize' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "uri": "/Users/kevinlin/Dendron",
+    "config": {
+        "vaults": ["/Users/kevinlin/Dendron/vault"]
+    }
+}'
+```

Added: vault/dendron.pro.dendron-cli.dev.md

Files changed (1) hide show

vault/dendron.pro.dendron-cli.dev.md +17 -0

vault/dendron.pro.dendron-cli.dev.md ADDED Viewed

@@ -0,0 +1,17 @@
+---
+id: 832a6e4d-4ed9-414f-baa8-d2f20432c934
+title: Dev
+desc: ''
+updated: 1609350699104
+created: 1609350672493
+---
+## Issues
+### Unexpected Token
+  name: 'EleventyConfigError',
+  originalError:
+   /codebuild/output/src896656404/src/staging/node_modules/@dendronhq/dendron-11ty/libs/utils.js:68
+     static getUrl = (note) => {
+   SyntaxError: Unexpected token =

Added: vault/dendron.pro.dendron-cli.md

Files changed (1) hide show

vault/dendron.pro.dendron-cli.md +9 -0

vault/dendron.pro.dendron-cli.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: c968377f-56e5-470f-801e-c730a1c071d4
+title: Dendron CLI
+desc: ''
+updated: 1614924056383
+created: 1614837297111
+---
+The Dendron CLI exposes Dendron's functionality via the command line.

Added: vault/dendron.pro.dendron-cli.qa.md

Files changed (1) hide show

vault/dendron.pro.dendron-cli.qa.md +12 -0

vault/dendron.pro.dendron-cli.qa.md ADDED Viewed

@@ -0,0 +1,12 @@
+---
+id: a49370b7-fe61-4174-bf85-f67d15fa35ff
+title: Qa
+desc: ''
+updated: 1614837591776
+created: 1614837254472
+---
+## Debug
+To debug specific dendron-cli commands, run a CLI [[tasks|dendron.dev.ref.vscode#tasks]] from `dendron-cli/.vscode/tasks.json`
+See the `build-site` inside `tasks.json` for an example.

Added: vault/dendron.pro.dendron-engine.cook.md

Files changed (1) hide show

vault/dendron.pro.dendron-engine.cook.md +105 -0

vault/dendron.pro.dendron-engine.cook.md ADDED Viewed

@@ -0,0 +1,105 @@
+---
+id: 1bce1c33-c14b-4e5e-b493-45683c8cf54f
+title: Cook
+desc: ''
+updated: 1615092736145
+created: 1610469139531
+---
+### Adding a new unified plugin
+<!-- - [pr example](https://github.com/dendronhq/dendron/pull/260)  -->
+<!-- ea648849f94528d8000a31fd8b89ca8c89de2598 -->
+Resources:
+- [video of pairing session](https://youtu.be/mHkx17akuCg)
+- [commit from pairing session](https://github.com/dendronhq/dendron/commit/ea648849f94528d8000a31fd8b89ca8c89de2598)
+Context:
+- Dendron uses [remark](https://github.com/remarkjs/remark) and [rehype](https://github.com/rehypejs/rehype) to handle markdown and html transformations
+- Dendron uses a series of [processors](https://github.com/unifiedjs/unified#processor) to group unified plugins
+- Dendron currently compiles markdown into output formats listed [here](https://github.com/dendronhq/dendron/blob/master/packages/engine-server/src/markdown/types.ts#L28:L28)
+Steps:
+1. add the plugin to engine-server
+    - NOTE: we are still using remark12 so make sure to install the remark12 compatible version of the plugin
+    - instructions to add new packages [[here|dendron.dev.cook#install-a-new-package]]
+1. update `src/markdown/utils.ts` in engine-server
+    - import plugin and add it to the appropriate processor (most likely `procFull`)
+1. write a test for the plugin. plugin tests are located in `engine-test-utils/src/__tests__/engine-server/markdown/`
+    - example [here](https://github.com/dendronhq/dendron/blob/master/packages/engine-test-utils/src/__tests__/engine-server/markdown/container.spec.ts)
+    - `createProcTests` is a special function that sets up a Dendron workspace and can help you run a unified processor for multiple output formats
+    - your test should cover every output format that your plugin affects
+    - best way to understand is by example, see the other tests in the same folder for additional examples of how to use this function
+1. write the plugin implementation
+1. make sure your tests pass
+    - its helpful to use the `matchSnapshot` functionality that jest provides
+    if you use the `checkVFile` helper function, this happens automatically
+    - you can view snapshots in `__snapshots__/` folder which is relative to the test
+1. add a flag in `DendronConfig` to toggle the plugin
+    - by default, new plugins are opt-in
+    - if the plugin only affects HTML output, you can put the option in `DendronSiteConfig`
+1. go back into `src/markdown/utils.ts` and use the newly created config value
+    - pass it in as an optional param in `proc*`
+    - conditionally add plugin in config is present
+1. add a test that makes sure the plugin doesn't take into affect if the config is not enabled
+Notes on testing:
+- when testing `transformers`, `process` will run over the node that is passed in to the processor
+- when testing `parsers` and `compilers`, `process` will run over the text that you pass into it
+### Connecting to the engine
+```ts
+import { DEngineClientV2, EngineConnector } from "@dendronhq/engine-server";
+let dendronEngine: DEngineClientV2;
+const connector = EngineConnector.instance();
+if (_.isUndefined(connector._engine)) {
+    return vscode.window.showInformationMessage(
+    "Still initializing. Please close this window and try again after Dendron has been initialized",
+    );
+}
+dendronEngine = connector.engine;
+if (!engine) {
+    engine = this.initMarkdownEngine({ sourceUri, dendronEngine });
+}
+```
+### Querying notes by ID
+- [type definitions](https://github.com/dendronhq/dendron/blob/master/packages/common-all/src/typesv2.ts#L362:L362)
+```ts
+engine.queryNote
+```
+### Query notes by file name
+- note: make sure that the engine is initialized
+- with vault
+```ts
+import {NoteUtilsV2} from "@dendronhq/engine-server";
+const maybeNode = NoteUtilsV2.getNoteByFnameV4({
+    fname: dirname,
+    notes: nodes,
+    vault,
+});
+```
+- without vault (gets all notes with this name)
+```ts
+import {NoteUtilsV2} from "@dendronhq/engine-server";
+const maybeNode = NoteUtilsV2.getNotesByFname({({
+    fname: dirname,
+    notes: nodes,
+});
+```
+### Note Response
+![[dendron.pro.dendron-engine.ref.note-response]]

Added: vault/dendron.pro.dendron-engine.internal.markdown.md

Files changed (1) hide show

vault/dendron.pro.dendron-engine.internal.markdown.md +68 -0

vault/dendron.pro.dendron-engine.internal.markdown.md ADDED Viewed

@@ -0,0 +1,68 @@
+---
+id: 8289cf77-51fa-4644-96c6-b5b2c2ef62fc
+title: Markdown
+desc: ''
+updated: 1614024416739
+created: 1613752938733
+---
+## Note Refs - Markdown
+- file: src/markdown/remark/noteRefsV2.ts
+```ts
+compiler {
+    if dest != MD_DENDRON:
+        convertNoteRef
+}
+convertNoteRef {
+    refLvl := proc
+    return if refLvl > MAX_REF_LVL
+    noteRefs :=
+    noteRefs.map {
+        convertNoteRefHelper
+    }
+}
+convertNoteRefHelper(body) {
+    bodyAST = proc.parse body
+    let out = proc
+      .processSync(noteRefProc.stringify(bodyAST))
+    return out
+}
+```
+```ts
+```
+## Note Refs - HTML
+- file: src/markdown/remark/dendronPub.ts
+```ts
+data = convertNoteRefASTV2
+parent.children = data;
+```
+```ts
+convertNoteRefASTV2 {
+        noteRefs :=
+        noteRefs.map {
+            convertNoteRefHelperAST
+        }
+}
+convertNoteRefHelperAST(noteRefProc) {
+    /**
+     *  RefLink Node
+     */
+    bodyAST = noteRefProc.parse(body)
+}
+```

Added: vault/dendron.pro.dendron-engine.internal.md

Files changed (1) hide show

vault/dendron.pro.dendron-engine.internal.md +81 -0

vault/dendron.pro.dendron-engine.internal.md ADDED Viewed

@@ -0,0 +1,81 @@
+---
+id: 26be950a-eaf3-4684-bddd-64be52273b73
+title: Internal
+desc: ''
+updated: 1614924289100
+created: 1608527496774
+---
+## Initializing a new workspace
+- engine-server/src/workspace.ts
+```ts
+WorkspaceService.createWorkspace
+```
+## Initializing dendron.yml
+## Renaming a Note
+### Flow
+- engine-server/src/drivers/file/storev2.ts
+```ts
+renameNote opts {
+  oldNote, oldLoc, newLoc := opts
+  notesToChange = getNotesWithLinkTo(oldNote)
+  notesToChange.forEach { n =>
+    replaceLinks(n, from: oldLoc, to: newLoc)
+    n.links = findLinks(n)
+  }
+  newNote = {oldNote, newLoc}
+  @deleteNote( oldNode, metaOnly)
+}
+```
+- src/topics/markdown/utilsv2.ts
+```ts
+replaceLinks opts {
+  remark = getRemark(dendronLinksOpts: {replaceLink: { from, to }} )
+  return remark.process(opts.content).toString()
+}
+```
+- src/drivers/file/storev2.ts
+```ts
+deleteNote(note) {
+  ...
+  if !note.children {
+    ...
+  } else {
+  }
+}
+```
+- See [[Remark|dendron.dev.design.remark]]
+## MISC
+### Does Dendron use parent/children metadata inside notes during initialization?
+- src/filesv2.ts: `string2Note`
+# WorkspaceService: Add Vault
+- src/workspace.ts
+```ts
+createVault(vault, noAddToConfig):
+  ensureDir(vault)
+  createNoteRoot if not_exist
+  createSchemaRoot if not_exist
+  if !noAddToConfig:
+    config.add vault
+```

Added: vault/dendron.pro.dendron-engine.md

Files changed (1) hide show

vault/dendron.pro.dendron-engine.md +62 -0

vault/dendron.pro.dendron-engine.md ADDED Viewed

@@ -0,0 +1,62 @@
+---
+id: 5a7103be-eb92-4380-8207-598e9f10724c
+title: Dendron Engine
+desc: ''
+updated: 1609699498153
+created: 1605108924902
+---
+The engine provides the core of dendron's capabilities.
+# Components
+## Fuse.js
+- https://fusejs.io
+- powers dendron fuzzy search
+### Cook
+#### Tune Search Results
+1. checkout fuse.js from <https://github.com/krisk/fuse>
+2. install dependencies
+   ```bash
+   npm install
+   ```
+3. build the docs
+   ```bash
+   npm run docs:dev
+   ```
+4. modify `docs/.vuepress/components/Demo/Demo.vue`
+   - example of setting custom parameters
+   ```js
+   let codify = (pattern) => {
+   return `const options = {
+       shouldSort: true,
+       threshold: 0.6,
+       location: 0,
+       distance: 50,
+       maxPatternLength: 32,
+       minMatchCharLength: 2,
+       useExtendedSearch: true,
+       includeScore: true,
+   keys: [
+       "title",
+   ]
+   };
+   const fuse = new Fuse(list, options);
+   // Change the pattern
+   const pattern = "${pattern}"
+   return fuse.search(pattern)`
+   }
+   ```
+## Related
+- [[Server Migration|dendron.roadmap.project.n.2020.server-migration]]

Added: vault/dendron.pro.dendron-engine.qa.md

Files changed (1) hide show

vault/dendron.pro.dendron-engine.qa.md +18 -0

vault/dendron.pro.dendron-engine.qa.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+id: 60fbcc05-df2a-44a2-aa0e-cdd62c2557b6
+title: Qa
+desc: ''
+updated: 1614812452030
+created: 1614812225185
+---
+## Unified Tests
+These tests cover everything related to `unified` plugins. This refers to anything in packages/engine-server/src/markdown/utils.ts
+- plugin tests are located in `packages/engine-test-utils/src/__tests__/engine-server/markdown/`
+- [terminology](https://www.kevinslin.com/notes/09b6c659-3fe3-4a7d-98f9-47e7167cca5b.html) to understand
+- when testing `transformers`, `process` will run over the node that is passed in to the processor
+- when testing `parsers` and `compilers`, `process` will run over the text that you pass into it
+### Transformer Test

Added: vault/dendron.pro.dendron-engine.ref.md

Files changed (1) hide show

vault/dendron.pro.dendron-engine.ref.md +9 -0

vault/dendron.pro.dendron-engine.ref.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: 6ef73a3c-d3c0-4e21-9d77-76ad353a3cf9
+title: Ref
+desc: ''
+updated: 1611162452714
+created: 1611162452714
+stub: true
+---

Added: vault/dendron.pro.dendron-engine.ref.note-response.md

Files changed (1) hide show

vault/dendron.pro.dendron-engine.ref.note-response.md +53 -0

vault/dendron.pro.dendron-engine.ref.note-response.md ADDED Viewed

@@ -0,0 +1,53 @@
+---
+id: 0db94b86-d5c2-4e70-8f61-1a686fa8cc1d
+title: Note Response
+desc: ''
+updated: 1614294605017
+created: 1611160590954
+---
+- NOTE: response has been truncated in some areas with `...` for sake of clarity
+```json
+{
+    "id": "e3002a40-6571-4120-8311-c4a9af948e07",
+    "title": "Foo",
+    "vault": {
+        "fsPath": "/Users/kevinlin/Dropbox/Apps/Noah/vaults/people-vault"
+    },
+    "type": "note",
+    "desc": "",
+    "links": [
+        {
+            "type": "wiki",
+            "from": {
+                "fname": "foo",
+                "id": "e3002a40-6571-4120-8311-c4a9af948e07"
+            },
+            "original": "people.james",
+            "value": "people.james",
+            "alias": "people.james",
+            "pos": {
+                "start": 128,
+                "end": 155
+            },
+            "to": {
+                "fname": "people.james"
+            }
+        },
+        ...
+    ],
+    "fname": "foo",
+    "updated": 1610409926314,
+    "created": 1610381470060,
+    "parent": "af9c2275-84dd-4d86-b0a3-af9d8cd2fb08",
+    "children": [],
+    "body": "...",
+    "data": {},
+    "custom": {
+        "published": true
+    }
+}
+```
+## Links
+- [type definition](https://github.com/dendronhq/dendron/blob/master/packages/common-all/src/typesv2.ts#L166:L166)

Added: vault/dendron.pro.dendron-engine.ref.unified.md

Files changed (1) hide show

vault/dendron.pro.dendron-engine.ref.unified.md +169 -0

vault/dendron.pro.dendron-engine.ref.unified.md ADDED Viewed

@@ -0,0 +1,169 @@
+---
+id: a97e7686-41ae-41e3-8db0-004daea947f9
+title: Unified
+desc: ''
+updated: 1614542120377
+created: 1614541791058
+---
+exports[`proto wiilinks as list 1`] = `
+Object {
+  "children": Array [
+    Object {
+      "children": Array [
+        Object {
+          "checked": null,
+          "children": Array [
+            Object {
+              "children": Array [
+                Object {
+                  "data": Object {
+                    "alias": "one",
+                    "anchorHeader": undefined,
+                    "vaultName": undefined,
+                  },
+                  "position": Position {
+                    "end": Object {
+                      "column": 10,
+                      "line": 1,
+                      "offset": 9,
+                    },
+                    "indent": Array [],
+                    "start": Object {
+                      "column": 3,
+                      "line": 1,
+                      "offset": 2,
+                    },
+                  },
+                  "type": "wikiLink",
+                  "value": "one",
+                },
+              ],
+              "position": Position {
+                "end": Object {
+                  "column": 10,
+                  "line": 1,
+                  "offset": 9,
+                },
+                "indent": Array [],
+                "start": Object {
+                  "column": 3,
+                  "line": 1,
+                  "offset": 2,
+                },
+              },
+              "type": "paragraph",
+            },
+          ],
+          "position": Position {
+            "end": Object {
+              "column": 10,
+              "line": 1,
+              "offset": 9,
+            },
+            "indent": Array [],
+            "start": Object {
+              "column": 1,
+              "line": 1,
+              "offset": 0,
+            },
+          },
+          "spread": false,
+          "type": "listItem",
+        },
+        Object {
+          "checked": null,
+          "children": Array [
+            Object {
+              "children": Array [
+                Object {
+                  "data": Object {
+                    "alias": "two",
+                    "anchorHeader": undefined,
+                    "vaultName": undefined,
+                  },
+                  "position": Position {
+                    "end": Object {
+                      "column": 10,
+                      "line": 2,
+                      "offset": 19,
+                    },
+                    "indent": Array [],
+                    "start": Object {
+                      "column": 3,
+                      "line": 2,
+                      "offset": 12,
+                    },
+                  },
+                  "type": "wikiLink",
+                  "value": "two",
+                },
+              ],
+              "position": Position {
+                "end": Object {
+                  "column": 10,
+                  "line": 2,
+                  "offset": 19,
+                },
+                "indent": Array [],
+                "start": Object {
+                  "column": 3,
+                  "line": 2,
+                  "offset": 12,
+                },
+              },
+              "type": "paragraph",
+            },
+          ],
+          "position": Position {
+            "end": Object {
+              "column": 10,
+              "line": 2,
+              "offset": 19,
+            },
+            "indent": Array [],
+            "start": Object {
+              "column": 1,
+              "line": 2,
+              "offset": 10,
+            },
+          },
+          "spread": false,
+          "type": "listItem",
+        },
+      ],
+      "ordered": false,
+      "position": Position {
+        "end": Object {
+          "column": 10,
+          "line": 2,
+          "offset": 19,
+        },
+        "indent": Array [
+          1,
+        ],
+        "start": Object {
+          "column": 1,
+          "line": 1,
+          "offset": 0,
+        },
+      },
+      "spread": false,
+      "start": null,
+      "type": "list",
+    },
+  ],
+  "position": Object {
+    "end": Object {
+      "column": 10,
+      "line": 2,
+      "offset": 19,
+    },
+    "start": Object {
+      "column": 1,
+      "line": 1,
+      "offset": 0,
+    },
+  },
+  "type": "root",
+};

Added: vault/dendron.pro.dendron-jekyll.md

Files changed (1) hide show

vault/dendron.pro.dendron-jekyll.md +37 -0

vault/dendron.pro.dendron-jekyll.md ADDED Viewed

@@ -0,0 +1,37 @@
+---
+id: 4c0ef322-3006-405c-9a66-3134dd9649a5
+title: Dendron Jekyll
+desc: ''
+updated: 1596683603070
+created: 1596683603070
+stub: false
+---
+This is the Jekyll theme used by Dendron. It is a fork of [just-the-docs](https://pmarsceill.github.io/just-the-docs/) theme with custom changes to allow for deep hierarchies, lookups and unique ids. It also borrows many elements from the [Minimal Mistakes theme](https://mmistakes.github.io/minimal-mistakes/).
+- [github repo](https://github.com/dendronhq/dendron-jekyll)
+# Blogging
+dendron-jekyll has custom layouts well suited for blogging. You can see an example of it in action [here](https://www.kevinslin.com/notes/b9bc4aa1-4369-446d-91a9-13d4f2a4b8e5.html).
+Blog Optimized Features:
+- ability to show all notes within a hierarchy organized by timestamp
+- wider layout for the text
+- helper utilities from [minimal mistakes](https://mmistakes.github.io/minimal-mistakes/docs/helpers/)
+  - NOTE: currently, only `figure` is supported
+## Getting Started
+- 🚧 Instructions are currently being written and will be up soon
+# Remote and Gem Based Themes
+Dendron Jekyll works as both a github remote theme and as a gem based theme. [dendron.so](https://dendron.so) is built from dendron-jekyll as a remote-theme from this [repo](https://github.com/dendronhq/dendron-template) and deployed using [github pages](https://pages.github.com/).
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/jekyll-dendron-so.gif)
+[kevinslin.com](https://www.kevinslin.com/) is built as a gem based theme from a private github repo and deployed using [AWS Amplify](https://aws.amazon.com/amplify/).
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/jekyll-kevinslin.gif)

Added: vault/dendron.pro.dendron-jekyll.topic.frontmatter.md

Files changed (1) hide show

vault/dendron.pro.dendron-jekyll.topic.frontmatter.md +47 -0

vault/dendron.pro.dendron-jekyll.topic.frontmatter.md ADDED Viewed

@@ -0,0 +1,47 @@
+---
+id: f9c646b1-34ab-4b18-8ec1-cabb8b2c7066
+title: Frontmatter
+desc: ''
+updated: 1600573427628
+created: 1600573427628
+stub: false
+---
+Dendron notes have [[frontmatter|dendron.topic.frontmatter]]. Dendron Jekyll uses this frontmatter to configure various aspects about the appearance and publication status of a particular page.
+## Appearance
+### title: string
+Title of the content. Control's how the title shows up in the nav bar
+### sources: source\[]
+Automatically create attributions for a page
+- eg: [AWS Page](https://aws.dendron.so/notes/dynamodb.html#)
+```yml
+...
+sources:
+  - name: og-aws
+    url: 'https://github.com/open-guides/og-aws'
+    license: Creative Commons Attribution-ShareAlike 4.0 International License
+  - name: Jerry Hargrove
+    url: 'https://www.awsgeek.com/'
+    license: Creative Commons Attribution-ShareAlike 4.0 International License
+```
+![](/assets/images/2020-09-19-20-53-12.png)
+## Publication
+### published: boolean
+Specifies if the page should be published or not.
+By default, everything under `siteHierarchies` is published unless `publishByDefault` is turned `off`. In that case, you must set `published: true` in order to publish a page under the given hierarchy.
+You can also set this to `false` to selectively withhold specific pages from publication.
+((ref:[[dendron.topic.publishing.configuration]]#config:#*))

Added: vault/dendron.pro.dendron-jekyll.topic.math.md

Files changed (1) hide show

vault/dendron.pro.dendron-jekyll.topic.math.md +38 -0

vault/dendron.pro.dendron-jekyll.topic.math.md ADDED Viewed

@@ -0,0 +1,38 @@
+---
+id: 84e01690-4ea0-4b71-8cc4-c2d38e09dcf4
+title: Math
+desc: ''
+updated: 1603589517663
+created: 1602087509879
+stub: false
+---
+You can enable math using the following options in the `_config.yml`. By default, this will be located in `{workspace}/docs/_config.yml`
+```yml
+enable_mathjax: true;
+kramdown:
+  math_engine: mathjax
+```
+- NOTE: If you are using the local preview, be sure to reload your server to have the changes take place.
+You can now add math using the standard [mathjax](https://www.mathjax.org/) notation.
+- NOTE:  only `block level` mathjax is supported at the current time
+### Example
+The following
+```
+$$
+f(x) = sin(x)
+$$
+```
+will render as
+$$
+f(x) = sin(x)
+$$

Added: vault/dendron.pro.dendron-jekyll.topic.md

Files changed (1) hide show

vault/dendron.pro.dendron-jekyll.topic.md +9 -0

vault/dendron.pro.dendron-jekyll.topic.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: 442df590-669a-45b4-8e0c-ba9bd699413f
+title: Topics
+desc: ''
+updated: 1600573417342
+created: 1600573417342
+stub: false
+---

Added: vault/dendron.pro.dendron-next-server.md

Files changed (1) hide show

vault/dendron.pro.dendron-next-server.md +41 -0

vault/dendron.pro.dendron-next-server.md ADDED Viewed

@@ -0,0 +1,41 @@
+---
+id: 7cdd9a74-8b8f-4564-906b-c963bed34273
+title: Dendron Next Server
+desc: ''
+updated: 1614924050218
+created: 1604511741960
+---
+## Quickstart
+1. follow instructions [[here|dendron.dev.setup]] to clone the repository and install dependencies
+2. navigate to server package
+   ```bash
+   cd {repo-root}/packages/dendron-next-server
+   ```
+3. start server
+   ```bash
+   yarn dev
+   ```
+4. Open `dendron-next-server.code-workspace` to start editing the code
+## Working with the Dendron Engine
+If your working with the Dendron Engine (eg. fetching notes, config or schemas), you'll need to start an instance of the engine.
+First, install the Dendron CLI
+((ref:[[dendron.topic.cli]]#installation,1:#*))
+Next, use the `launchEngineServer` command to start the server to an existing workspace
+```
+LOG_DST=/tmp/server.txt LOG_LEVEL=debug dendron-cli launchEngineServer --port 3005 --wsRoot ~/Dendron/
+```
+Create an `.env.local` file under `dendron-next-server` and add the following
+```
+ENGINE_ENDPOINT_PORT=3005
+```
+Run `yarn dev` to start the next server

Added: vault/dendron.pro.dendron-plugin.deploy.md

Files changed (1) hide show

vault/dendron.pro.dendron-plugin.deploy.md +143 -0

vault/dendron.pro.dendron-plugin.deploy.md ADDED Viewed

@@ -0,0 +1,143 @@
+---
+id: 2976e5df-c8b4-4176-9d3f-fe4220dfa9b6
+title: Deploy
+desc: ''
+updated: 1615242299836
+created: 1613863275374
+---
+## pre-req
+```sh
+npm install -g verdaccio
+npm install -g yarn
+npm install -g vsce
+sudo apt-get install jq -y
+git clone git@github.com:dendronhq/dendron.git dendron
+git clone git@github.com:dendronhq/dendron.git dendron-build
+```
+- run verdaccio
+```
+verdaccio
+```
+## build and source
+```sh
+yarn
+yarn bootstrap:build
+. bootstrap/scripts/helpers.sh
+```
+## test local
+- publish from local
+```sh
+setRegLocal
+verdaccio
+gbD integ-publish
+gco -b integ-publish
+version=minor
+lerna version $version --no-git-tag-version
+git add .
+git commit -m "integ: publish $version"
+git push --set-upstream origin integ-publish --force
+lerna publish from-package
+# if you already built
+lerna publish from-package --ignore-scripts
+node bootstrap/scripts/genMeta.js
+```
+- pull in new changes
+```sh
+WORKSPACE_BUILD=/mnt/one/dendron-build
+WORKSPACE_BUILD=/Users/kevinlin/projects/dendronv2/dendron/build/dendron/packages/plugin-core
+cd $WORKSPACE_BUILD
+git reset --hard
+git clean -f
+gco master
+gbD integ-publish
+git checkout --track origin/integ-publish
+# installing
+./scripts/package.sh
+./scripts/install.sh
+# combine the above
+./scripts/pack_and_install.sh
+```
+- test changes
+    - [ ] any packages installed will be with verdaccio so don't use dendron-site
+## publish
+- checkout
+```
+gco master
+setRegRemote
+```
+- [ ] cherry pick if needed
+```
+version=minor
+lerna version $version
+lerna publish from-package
+lerna publish from-package --ignore-scripts
+```
+- pull in new changes
+```
+git reset --hard
+git clean -f
+gco master
+sleep 60
+./scripts/pack_and_install.sh
+```
+## re-publish
+```sh
+./unpublish.sh
+lerna publish from-package --ignore-scripts
+```
+## cleanup
+```
+cd $WORKSPACE_BUILD
+gbD integ-publish
+cd $WORKSPACE
+gbD integ-publish
+```
+## cook
+### unpublish a package
+```
+./unpublish.sh
+```
+## rest
+### git
+```sh
+yarn
+yarn bootstrap:build
+. bootstrap/scripts/helpers.sh
+```

Added: vault/dendron.pro.dendron-plugin.internal.lookup.md

Files changed (1) hide show

vault/dendron.pro.dendron-plugin.internal.lookup.md +53 -0

vault/dendron.pro.dendron-plugin.internal.lookup.md ADDED Viewed

@@ -0,0 +1,53 @@
+---
+id: f528e8ad-a3f9-4f66-af1d-0af400014383
+title: Lookup
+desc: ''
+updated: 1610206601056
+created: 1610205567544
+---
+## Summary
+## Code
+### updateItems
+```ts
+onUpdatePickerItem {
+    if picker.justActivated {
+        modify picker value to be current parent
+    }
+    @showRootResults if querystring = ""
+    items = picker.items
+    updatedItems = filterDefault(items)
+    updatedItems = createPickerItemsFromEngine()
+    // check for single letter queries
+    if no activeItems and querystring.length = 1  {
+        picker.items = updatedItems
+        return;
+    }
+    if $noteQuery {
+        // add schema to suggestion
+        // ...
+    }
+    // empty results
+    if !updatedItems {
+        return
+    }
+}
+```
+### createPickerItemsFromEngine
+```ts
+createPickerItemsFromEngine {
+    resp = await engine.queryNotes
+    ...
+}
+```

Added: vault/dendron.pro.dendron-plugin.internal.md

Files changed (1) hide show

vault/dendron.pro.dendron-plugin.internal.md +160 -0

vault/dendron.pro.dendron-plugin.internal.md ADDED Viewed

@@ -0,0 +1,160 @@
+---
+id: 4b8f0470-dacb-433b-8d0c-f5a7d8f5245d
+title: Lookup
+desc: ''
+updated: 1610160273101
+created: 1608838048476
+---
+```ts
+show {
+    quickpick := create
+    provider := new LookupProvider
+    @refreshButtons
+    @updatePickerBehavior
+    provider.provide quickpick
+    quickpick.show
+}
+```
+```ts
+refreshButtons(buttons) {
+    @state.buttonsPrev = quickpickButtons
+    quickpick.buttons = buttons
+}
+```
+```ts
+updatePickerBehavior {
+    @updateBehaviorByEffect
+    if changedNoteType {
+        @updateBehaviorByNoteType
+    }
+    if changedFilterType
+        @provider.onUpdatePickerItem
+    quickpick.oncreate :=
+}
+```
+## Example
+### Normal
+- show
+- updatePickerBehavior
+  - source: updateBehaviorByNoteType(normal)
+### Change Value
+- updatePickerBehavior
+  - source: onValueChange
+## Ref
+### Times when Picker is Updated
+- onUpdatePickerItem
+  - lc.show, on init
+  - lc.updateBehaviorByNoteType, note type toggle
+  - lc.updatePickerBehavior, direct filter toggle
+### sources
+#### UPDATE_PICKER_FILTER
+- when direct filter has changed
+#### updatePickerBehavior
+- when changing note type
+- values
+  - normal
+  - journal
+  - scratch
+## Lookup: onButton
+- src/components/lookup/LookupControllerV2.ts
+```ts
+onTriggerButton {
+}
+```
+# TreeView
+## init
+- onInitialize, reconstruct the whole tre
+## refresh
+- ReloadIndex
+- SchemaWatcher
+- FileWatcher
+# Welcome Message
+- file: plugin-core/src/\_extension.ts
+```ts
+showWelcomeOrWhatsNew {
+    previousVersion := config.get(dendron.version)
+    version :=
+    // 1st install
+    if !previousVersion {
+        config.set(GLOBAL_STATE.VERSION, version)
+        config.set(GLOBAL_STATE.VERSION_PREV, 0.0.0)
+        return showWelcome()
+    }
+    // not 1st install
+    if (version != previousVersion) {
+        config.set(GLOBAL_STATE.VERSION, version)
+        config.set(GLOBAL_STATE.VERSION_PREV, previousVersion)
+        showInformationMessage(dendron has upgraded)
+    }
+}
+```
+## SetupWorkspace
+- note: `dendron.code-workspace` is completely overwritten when running setup
+# Vault Add
+- src/commands/VaultAddCommand.ts
+```ts
+execute:
+    vaults = handleRemote
+handleRemote:
+    repoDir :=
+    ensureDir(repoDir)
+    git clone gitRepo
+    vaults := repoDir
+    vaults.map { addVaultToWorkspace }
+addVaultToWorkspace vault:
+    createVault(vault)
+    addToWorkspaceFile(vault)
+```
+# Reload Index
+```ts
+ws.getEngine()
+engine.vaultsv3.map {
+}
+```

Added: vault/dendron.pro.dendron-plugin.internal.startup.md

Files changed (1) hide show

vault/dendron.pro.dendron-plugin.internal.startup.md +128 -0

vault/dendron.pro.dendron-plugin.internal.startup.md ADDED Viewed

@@ -0,0 +1,128 @@
+---
+id: 8d09cc3f-25e3-42a2-ac86-82806c0c8c65
+title: Startup
+desc: ''
+updated: 1610160307560
+created: 1610160007286
+---
+## Summary
+- check for dendron.code-workspace
+- start engine (local server that does indexing)
+- reload workspace (connect to the local server)
+- activate file watchers
+## Code
+- file: plugin-core/src/_extension.ts
+### Check for workspace
+```ts
+_activate {
+    ws := DendronWorkspace.getOrCreate
+    if ws.isActive {
+        port = startServer
+        updateEngineAPI(port)
+        startLSPClient
+        ws.reloadWorkspace // 312
+        ws.activateWatchers
+    }
+}
+```
+### Reload Workspace
+```ts
+// 49
+reloadWorkspace {
+    ws.reloadWorkspace
+    if isFirstInstall {
+        showTutorial
+    }
+    postReloadWorkspace
+    emit(extension, initialized)
+}
+```
+####  postReloadWorkspace
+```ts
+postReloadWorkspace {
+    ws :=
+    previousWsVersion = config.get(WORKSPACE_STATE.WS_VERSION)
+    if previousWsVersion == 0.0.0 {
+        execute(Upgrade)
+        config.set(WORKSPACE_STATE.WS_VERSION, ws.version)
+    } else {
+        newVersion :=
+        if (newVersion > previousWsVersion) {
+            execute(Upgrade)
+            config.set(WORKSPACE_STATE.WS_VERSION, ws.version)
+            emit(extension, upgraded)
+        }
+    }
+}
+```
+## Reference
+### getOrCreate
+```ts
+if !_DendronWorkspace
+    _DendronWorkspace = new DendronWorkspace
+```
+```ts
+constructor {
+    @_setupCommands
+    ...
+}
+```
+### startServer
+- file: src/_extension.ts:
+- related: [[launch|dendron.pro.dendron-api-server.internal#launch]]
+```ts
+startServer {
+    maybePort :=
+    if !maybePort {
+        launch()
+    }
+}
+```
+### updateEngine
+- [[workspace.vaults|dendron.pro.dendron-plugin.internal#workspacevaults]]
+```ts
+class EngineAPIService {
+    create {
+        const vaults =
+            DendronWorkspace.instance().vaults?.map((ent) => ent.fsPath) || [];
+        DendronEngineClient.create({ vaults, ws, port, history })
+    }
+}
+```
+### workspace.vaults
+```ts
+get vaults {
+}
+```
+### ws.reloadWorkspace
+```ts
+executeCommand(RELOAD_INDEX)
+```

Added: vault/dendron.pro.dendron-plugin.md

Files changed (1) hide show

vault/dendron.pro.dendron-plugin.md +39 -0

vault/dendron.pro.dendron-plugin.md ADDED Viewed

@@ -0,0 +1,39 @@
+---
+id: 87d90002-f480-45eb-a8c4-d00df4d61557
+title: Dendron Plugin
+desc: ''
+updated: 1611160743812
+created: 1605375348464
+---
+## Activation
+- check if we have an active dendron workspace
+# Cook
+### Create a new Command
+1. Add command to `DENDRON_COMMANDS` under `plugin-core/src/constants.ts`
+2. Open the command prompt, enter `Run Task`, and run `gen:config`
+   - this will add the command to `package.json`
+3. Create the new command in `plugin-core/src/commands/{COMMAND_NAME}.ts`
+   - you can copy the contents of an existing command (eg. `src/commands/ShowHelp.ts`) to help you get started
+4. Write tests
+   - tests are in `plugin-core/src/test/suite-integ/{COMMAND}`
+   - testing instructions are [[here|dendron.dev.testing]]
+5. Write command logic
+6. If it makes sense, add a keyboard shortcut for the command. Make sure it doesn't conflict with an generic VSCode command or existing Dendron commands. You can detect existing keybindings by using the guide [here](https://code.visualstudio.com/docs/getstarted/keybindings#_detecting-keybinding-conflicts)
+7. Add command to `src/commands/index.ts`
+8. Submit pull request
+### Create a new Pod
+1. setting up dev environment and getting started: https://dendron.so/notes/81da87be-2d4e-47b5-a1d6-c0d647e1ab00.html
+1. sample code for json export pod: https://github.com/dendronhq/dendron/blob/master/packages/pods-core/src/builtin/JSONPod.ts#L143:L143
+1. what you will get from `prepareNotesForExport`: https://dendron.so/notes/0db94b86-d5c2-4e70-8f61-1a686fa8cc1d.html
+1. anki pod: take notes and transform them to anki format
+# Dev
+You can control the log level in the workspace settings using `dendron.logLevel`. This sets the log level for the plugin and well any server it launches. You will need to restart the workspace for the log level to take effect.

Added: vault/dendron.pro.dendron-plugin.qa.md

Files changed (1) hide show

vault/dendron.pro.dendron-plugin.qa.md +23 -0

vault/dendron.pro.dendron-plugin.qa.md ADDED Viewed

@@ -0,0 +1,23 @@
+---
+id: c84aa95c-83b9-4d52-90a1-eeec8f0ca84f
+title: QA
+desc: ''
+updated: 1609716111365
+created: 1609713960639
+---
+### Writing Tests
+When writing a test for new functionality, make sure to consider both the `single` vault and `multi-vault` scenario.
+To write a test, use the `runLegacySingleWorkspaceTest` or `runLegacyMultiWorkspaceTest` methods to setup a mock Dendron workspace of the respective type.
+You can see an example of both in [plugin-core/src/test/suite-integ/RenameNoteV2.test.ts](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/test/suite-integ/RenameNoteV2.test.ts#L131:L131)
+The arguments are explained [here](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/test/testUtilsV3.ts#L70:L70).
+### Test Runner
+Note that VSCode uses [mocha](https://mochajs.org/) as its default test runner whereas Dendron uses  [jest](https://jestjs.io/).
+We shim the [jest methods](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/test/testUtilsv2.ts#L418:L418) when testing the plugin though so that we can re-use the same logic between our non-vscode packages and the Dendron VSCode Plugin.

Added: vault/dendron.pro.dendron-plugin.ref.lifecycle.md

Files changed (1) hide show

vault/dendron.pro.dendron-plugin.ref.lifecycle.md +31 -0

vault/dendron.pro.dendron-plugin.ref.lifecycle.md ADDED Viewed

@@ -0,0 +1,31 @@
+---
+id: d410c0d6-9ede-42ef-9c96-662902e4f488
+title: Lifecycle
+desc: ''
+updated: 1611428138285
+created: 1609714449234
+---
+## Workspace Creation
+This describes everything that happens after a user runs `Initialize Workspace`. See source code [here](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/commands/SetupWorkspace.ts#L37:L37).
+## Running a Command
+When a command is executed, it runs the following functions in order. Source code [here](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/commands/base.ts#L40:L40)
+- sanityCheck: does basic checks
+- enrichInputs: cleans up passed in inputs
+- execute: runs the actual command
+- showResponse: show response to the user
+## Activate
+- activating dendron involves the following steps
+    - dendron api server started
+    - dendron engine finish indexing notes
+- extension, initialized: engine is loaded
+- other
+    - extension, not_initialized: error with starting engine

Added: vault/dendron.pro.dendron-plugin.ref.md

Files changed (1) hide show

vault/dendron.pro.dendron-plugin.ref.md +9 -0

vault/dendron.pro.dendron-plugin.ref.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: 37313fad-34e1-4db9-8716-335499bdd698
+title: Ref
+desc: ''
+updated: 1609716274826
+created: 1609716274826
+stub: true
+---

Added: vault/dendron.pro.dendron-preview.deploy.md

Files changed (1) hide show

vault/dendron.pro.dendron-preview.deploy.md +31 -0

vault/dendron.pro.dendron-preview.deploy.md ADDED Viewed

@@ -0,0 +1,31 @@
+---
+id: fb2cfc7e-f71d-4ec6-8c17-90f323a6c075
+title: Deploy
+desc: ''
+updated: 1614534579472
+created: 1614031837862
+---
+### setup mume
+```
+cd $MUME_WORKSPACE
+gbD integ-publish
+gco -b integ-publish
+setRegLocal
+./scripts/relink.sh
+./scripts/bump.sh
+```
+### setup preview
+```
+cd $PREVIEW_WORKSPACE
+./scripts/relink.sh
+git add .
+git commit -m "chore: bump deps"
+gbD integ-publish
+gco -b integ-publish
+scripts/bump-pkg-install.sh
+```

Added: vault/dendron.pro.dendron-preview.md

Files changed (1) hide show

vault/dendron.pro.dendron-preview.md +8 -0

vault/dendron.pro.dendron-preview.md ADDED Viewed

@@ -0,0 +1,8 @@
+---
+id: 92df74a7-39e7-453a-b940-013f3a48f513
+title: Dendron-preview
+desc: ''
+updated: 1611516193599
+created: 1607127810303
+---

Added: vault/dendron.pro.dendron-preview.setup.md

Files changed (1) hide show

vault/dendron.pro.dendron-preview.setup.md +10 -0

vault/dendron.pro.dendron-preview.setup.md ADDED Viewed

@@ -0,0 +1,10 @@
+---
+id: 59c41809-f3e9-457a-8b2c-7daecf7d338f
+title: Setup
+desc: ''
+updated: 1611516203773
+created: 1611516198276
+---
+- TODO

Added: vault/dendron.pro.dendron-snippet-maker.md

Files changed (1) hide show

vault/dendron.pro.dendron-snippet-maker.md +20 -0

vault/dendron.pro.dendron-snippet-maker.md ADDED Viewed

@@ -0,0 +1,20 @@
+---
+id: 89980f03-f5fd-4c9a-8325-c450c1108150
+title: Dendron Snippet Maker
+desc: ''
+updated: 1599700231902
+created: 1599700231902
+stub: false
+---
+This is a standalone extension used by Dendron to help you more easily create snippets.
+# Commands
+### Create Global Snippet
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/snippet.create.gif)
+#### Goto Global Snippet
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/snippet.goto.gif)

Added: vault/dendron.pro.devto-pod.md

Files changed (1) hide show

vault/dendron.pro.devto-pod.md +57 -0

vault/dendron.pro.devto-pod.md ADDED Viewed

@@ -0,0 +1,57 @@
+---
+id: c6adf905-2f74-4235-a2dc-c85b4711ea4a
+title: Dev.to Pod
+desc: ''
+updated: 1614313013455
+created: 1614191155933
+---
+## Summary
+This pod lets you publish your Dendron notes to dev.to
+- id: `dendron.devto`
+- [github](https://github.com/dendronhq/devto-pod)
+- coverage
+  - ❌ export
+  - ❌ import
+  - ✅ publish
+## Instructions
+### Installation
+```sh
+cd {workspace}
+npm init -y
+npm install -g dendron-cli
+npm install --save @dendronhq/devto-pod
+```
+### Usage
+The below command will publish $FILE_NAME to Dev.To
+```sh
+API_KEY={API_KEY}
+FILE_NAME={FNAME}
+cd {workspace}
+dendron-cli publishPod --wsRoot . --podId dendron.devto --podPkg @dendronhq/devto-pod --podSource custom --config fname=$FILE_NAME,vaultName=vault,dest=stdout,apiKey=$API_KEY
+```
+## Configuration
+- apiKey: the API Key of your dev.to account. You can follow the instructions [here](https://docs.forem.com/api/#section/Authentication) to get it
+## Metadata
+The following values are used when publishing your post.
+* title: string
+    - source: frontmatter, title field
+    - note title
+* tags?: string[];
+    - source: frontmatter, `tags` field
+* canonical_url?: string;
+    - source: `dendron.yml`, obtained from `site.site_url`

Added: vault/dendron.pro.markdown-links.md

Files changed (1) hide show

vault/dendron.pro.markdown-links.md +7 -0

vault/dendron.pro.markdown-links.md ADDED Viewed

@@ -0,0 +1,7 @@
+---
+id: 9af9cf56-d2a0-47d1-b8bf-5a02c42ac2fd
+title: Markdown Links
+desc: ''
+updated: 1611516225457
+created: 1608753702392
+---

Added: vault/dendron.pro.markdown-links.setup.md

Files changed (1) hide show

vault/dendron.pro.markdown-links.setup.md +32 -0

vault/dendron.pro.markdown-links.setup.md ADDED Viewed

@@ -0,0 +1,32 @@
+---
+id: 85dace70-c2ef-46e9-b467-8d297c420421
+title: Setup
+desc: ''
+updated: 1614924050222
+created: 1611516225361
+---
+## Getting Started
+1. Install dependencies
+   ```bash
+   git clone https://github.com/dendronhq/markdown-links.git
+   cd markdown-links
+   npm install
+   ```
+2. Use `Run Extension` from the [[debug pane|dendron.dev.ref.vscode#debug-pane]] (note: this requires that dendron be installed. VSCode might ask you to install Dendron and reload at this point)
+3. Make sure you are inside a Dendron workspace. If not, either initialize one using `Dendron: Initialize Workspace` or change to one using `Dendron: Change Workspace`
+## Setup without Dendron Extension Installed
+Dendron markdown links depends on the dendron extension to be active. You can still make it work without the extension by the following instructions:
+1. Comment out the following in `package.json`
+   ```json
+   "extensionDependencies": [
+       "dendron.dendron"
+   ],
+   ```
+2. Follow step 2 in the setup instructions above.
+3. Instead of using the plugin to initialize a Dendron workspace, initialize the workspace using the `dendron-cli`
+   ((ref:[[dendron.topic.cli]]#launchengineserver,1:#*))

Added: vault/dendron.pro.md

Files changed (1) hide show

vault/dendron.pro.md +11 -0

vault/dendron.pro.md ADDED Viewed

@@ -0,0 +1,11 @@
+---
+id: 32cdd4aa-d9f6-4582-8d0c-07f64a00299b
+title: Related Projects
+desc: ''
+updated: 1604511830312
+created: 1596684856906
+stub: false
+nav_order: 10
+---

Added: vault/dendron.pro.pods.md

Files changed (1) hide show

vault/dendron.pro.pods.md +13 -0

vault/dendron.pro.pods.md ADDED Viewed

@@ -0,0 +1,13 @@
+---
+id: fd58336c-27ae-4334-945c-8c782a6bc36b
+title: Pods
+desc: ''
+updated: 1613845633407
+created: 1613845605602
+---
+This describes dendron [[pOds|dendron.topic.pod]] functionality
+## Export Port

Added: vault/dendron.quickstart.md

Files changed (1) hide show

vault/dendron.quickstart.md +49 -0

vault/dendron.quickstart.md ADDED Viewed

@@ -0,0 +1,49 @@
+---
+id: e86ac3ab-dbe1-47a1-bcd7-9df0d0490b40
+title: QuickStart
+updated: 1609992432166
+created: 1595170096361
+nav_order: 1
+---
+This guide will help get you started with Dendron.
+## Pre-requisites
+- [[Install Dendron|dendron.guides.install]]
+  <!-- - Get familiar with the [basics](https://code.visualstudio.com/docs/editor/codebasics) of VSCode, an open source [IDE](https://www.codecademy.com/articles/what-is-an-ide) from Microsoft (and what Dendron is built on top of)  -->
+## The Trail 🥾
+This section covers the basics of Dendron. Get started on the right foot and start growing your knowledge base.
+- [ ] Go through Dendron's basic [[concepts|dendron.concepts]]
+- [ ] Do your first [[lookup|dendron.topic.lookup]] - a better way to find your notes
+- [ ] Learn about [[schemas|dendron.topic.schema]] - a flexible type system for all your notes
+- [ ] Use a [[snippet|dendron.topic.snippets]]
+- [ ] Insert an [[image|dendron.topic.images]]
+- [ ] Create some [[links|dendron.topic.links]]
+- [ ] Explore additional features from [[Dendron's bundled extensions|dendron.topic.extensions]]
+- [ ] [[Publish|dendron.topic.publishing]] your vault
+- [ ] Join us on [discord](https://discord.com/invite/6j85zNX) and discuss all things knowledge management with your fellow trail blazers.
+## The Woods 🌲
+This section covers advanced functionality in Dendron. Become a seasoned backpacker by mastering these trails.
+- [ ] Check out our [[case studies|dendron.case-studies]]
+- [ ] Read our [[FAQ|dendron.faq]]
+- [ ] Explore the [[graph view|dendron.topic.graph-view]]
+- [ ] Execute custom [[Dendron commands|dendron.topic.commands]]
+- [ ] Understand [[frontmatter|dendron.topic.frontmatter]]
+- [ ] Adopt a [[pod|dendron.topic.pod]]
+- [ ] Create a [[special note|dendron.topic.special-notes]]
+## The Wilderness ⛰️
+This section covers additional topics and the wider ecosystem around Dendron
+- [ ] Find [[recipes|dendron.guides.cook]] to common operations (or contribute your own)
+- [ ] Found an issue or want to submit a feature request? Do so on [github](https://github.com/dendronhq/dendron/issues)
+- [ ] See and vote on what's coming next by checking out our [public roadmap](https://github.com/orgs/dendronhq/projects/1)
+- [ ] Stay tuned for more wilderness coming soon!

Added: vault/dendron.recruit.md

Files changed (1) hide show

vault/dendron.recruit.md +25 -0

vault/dendron.recruit.md ADDED Viewed

@@ -0,0 +1,25 @@
+---
+id: 0f9967bc-d657-496f-9b4b-d1c7ebfd496c
+title: Recruitment Pitch
+desc: ''
+updated: 1599936705684
+created: 1599936705684
+stub: false
+nav_exclude: true
+---
+[Dendron](https://dendron.so) is a note taking tool build around flexible hierarchies and bi-directional linking. It is meant to be the fastest way for people to create, find, and collaborate on the information they care about.
+All note taking tools make it easy for you to get information in. They all struggle to help you find that information once you've accumulated a good number of notes. Dendron is optimized to help you find your notes no matter how many notes you have (Kevin, the founder, uses Dendron to manage +20K notes, all of which he can access in seconds)
+Dendron is open source and local-first, meaning that anyone can build their own version of Dendron and that your data always stays with you. We build Dendron this way because we believe that access to one's knowledge is intimately personal and that you, as the user, should always have **full control of your knowledge**.
+> "We are overwhelmed with information and we don't have the tools to properly index and filter through it. [The development of these tools, which] will give society access to and command over the inherited knowledge of the ages [should] be the first objective of our scientist"
+>
+> - [Vannevar Bush](https://en.wikipedia.org/wiki/Vannevar_Bush), 1945
+Dendron's goal is to give society **access to and command over the inherited knowledge of the ages.** We launched in preview in the summer of 2020 and have had awesome traction with early adopters. We currently have over a thousand downloads and a budding community of Dendronites from around the world.
+To keep up with the growth of Dendronites while continuing to work towards our roadmap, we need help. We are looking for developers to help take Dendron to the next level.
+Dendron is built in typescript on top of VSCode. Knowledge of either is not required (though definitely preferred). You would be working alongside [myself](https://www.kevinslin.com) as well as our [global community of Dendronites](https://discord.gg/6j85zNX) to build a better way for people to **create, find, and collaborate** on knowledge that matters to them.

Added: vault/dendron.ref.intellisense.md

Files changed (1) hide show

vault/dendron.ref.intellisense.md +14 -0

vault/dendron.ref.intellisense.md ADDED Viewed

@@ -0,0 +1,14 @@
+---
+id: 032e4abc-f292-465f-9b6a-5a1360c2c974
+title: Intellisense
+desc: ''
+updated: 1599755804490
+created: 1599755804490
+stub: false
+---
+Intellisense is the auto completion mechanism used inside VSCode.
+You can read the docs about it [here](https://code.visualstudio.com/docs/editor/intellisense#_intellisense-features).
+To customize intellisense behavior, read the section on customization [here](https://code.visualstudio.com/docs/editor/intellisense#_customizing-intellisense)

Added: vault/dendron.ref.layout.md

Files changed (1) hide show

vault/dendron.ref.layout.md +58 -0

vault/dendron.ref.layout.md ADDED Viewed

@@ -0,0 +1,58 @@
+---
+id: 3bff1195-1d13-4e7a-bc2f-7e4cc617109c
+title: Layout
+desc: ''
+updated: 1614202013214
+created: 1596740451789
+stub: false
+---
+## File Tree
+### Basic
+```
+.
+├── dendron.code-workspace
+├── dendron.yml
+├── .dendron.port
+├── .dendron.meta
+├── docs/
+├── .gitignore
+└── vault/
+    ├── root.md
+    ├── root.schema.md
+    ├── dendron.md
+    ├── dendron.faq.md
+    ├── ...
+    └── assets/images
+```
+- dendron.code-workspace
+  - vscode and dendron configuration
+- dendron.yml
+  - dendron specific settings
+- .dendron.port
+  - writes the port that the [[dendron engine|dendron.pro.dendron-engine]] is listening to
+- .dendron.meta
+  - writes dendron specific metadata
+- .gitignore
+  - add special notes
+- docs/
+  - used to generate a static site from your vault
+- vault/
+  - `root.md `
+    - generated by dendron, root of all your hierarchies
+  - `root.schema.yml`
+    - generated by dendron, root of all of your schemas
+  - assets/images
+    - default for `Dendron Paste Image` extension to put images in
+## Terms
+### workspace root
+This is the folder where `dendron.code-workspace` is located
+## Additional Folders
+- pods: [[pod|dendron.topic.pod]] related files
+- seeds: [[seeds|dendron.topic.seeds]] related files
+- repos: used by dendron to store [[remote vaults|dendron.concepts#remote-vault]]

Added: vault/dendron.ref.md

Files changed (1) hide show

vault/dendron.ref.md +10 -0

vault/dendron.ref.md ADDED Viewed

@@ -0,0 +1,10 @@
+---
+id: f308164e-faff-43a1-8d34-72ed060275b0
+title: Reference
+desc: ''
+updated: 1615227295669
+created: 1596740440387
+nav_exclude: true
+---

Added: vault/dendron.ref.terms.md

Files changed (1) hide show

vault/dendron.ref.terms.md +27 -0

vault/dendron.ref.terms.md ADDED Viewed

@@ -0,0 +1,27 @@
+---
+id: 20b23165-d803-4eb2-98aa-0f0934dd3bd9
+title: Terms
+desc: ''
+updated: 1614057590921
+created: 1610064859384
+---
+### Slug
+Human readable part of url. See [wikipedia article](https://en.wikipedia.org/wiki/Clean_URL#Slug) for more details.
+Dendron uses [github-slugger](https://github.com/Flet/github-slugger) to generate slugs.
+### Pretty Ref
+A pretty ref is a [[note ref|dendron.topic.refs]] rendered with an outline.
+You can see an example below
+![Pretty Note refs](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/topic.note-ref-pretty.jpg)
+A regular note ref is embedded inline in the text.
+![Regular Note Ref](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/topic.note-ref-normal.jpg)

Added: vault/dendron.ref.titles.md

Files changed (1) hide show

vault/dendron.ref.titles.md +21 -0

vault/dendron.ref.titles.md ADDED Viewed

@@ -0,0 +1,21 @@
+---
+id: 554023aa-e21d-4082-8239-a1032ac54e61
+title: Titles
+desc: ''
+updated: 1609783328053
+created: 1609783322468
+---
+We recommend using all lower kebab case when naming your files. For example, `awesome apples` would be `awesome-apples`. This would be stored in your file system as `awesome-apples.md`.
+Dendron will auto-generate a human friendly title based on the last part of your hierarchy. By default, Dendron uses [title.sh](https://title.sh/) to generate titles based on your note name. Titles generated are consistent with the [Chicago Manual of Style](https://www.chicagomanualofstyle.org/home.html). Dendron will replace `-` with a ` ` when generating titles.
+If you end up adding custom capitalization to your file name, Dendron will not attempt to generate a title but return the last part of your hiearchy as is.
+Some examples below:
+```
+- awesome-apples.md -> title: Awesome Apples
+- fruit.awesome-apples.md -> title: Awesome Apples
+- fruit.Custom-Capitalization -> title: Custom-Capitalization
+```

Added: vault/dendron.ref.transcript.md

Files changed (1) hide show

vault/dendron.ref.transcript.md +266 -0

vault/dendron.ref.transcript.md ADDED Viewed

@@ -0,0 +1,266 @@
+---
+id: 097cf7ed-e9aa-4580-86cf-0347bf7a623d
+title: Dendron Onboarding Transcript
+desc: ''
+updated: 1599235587751
+created: 1599235587751
+stub: false
+---
+0:00
+So getting started? And have you had a chance to play around with engine at all, or this is the first time.
+0:07
+Um, I've opened it and read a little bit of the doc in it. And that's all I've done.
+0:13
+Okay, cool. That's perfect. And so right now,
+0:17
+when you turned up in the, in the, in the couple of discord threads was really the first point that I looked at it at all, and I haven't spent much time looking. And then you throw this out, like, Okay, this jumpstart.
+0:33
+Cool. Yeah. And that's kind of what this onboarding is for. It's, it's, you know, today's help, even if you haven't even opened it up just to give you the idea of, you know, why you might want to. And so right now, what you're looking at is identity and workspace, and the way so let's back up and tension. We manage your notes and our work states and if you use VS code, it's the equivalent of the VS code workspace. So that's a one to one match in there. And the way that you start off is you can initialize the workspace. And right now, I did me, we can just make a new one, like lead you. And so this is saying the workspace should be at this location. And so when we create a workspace, we can either create one with intention tutorial notes, and that has right or you can do an empty one. So I'm just going to do an empty one in this case. And so when you create an empty workspace, you have one file, which is the root file. And this is just there for this is kind of like your phone. And the way that denture and works is if you want to create a file, you can just type command L. I'm going to toggle screencast mode, command l triggers to look up bar, and most of the things you'll do in engine will involve this one have you used tools like Notational Velocity no So Notational Velocity, it's it was a tool where basically when you are looking for a file, for example, if I type Python, if the file doesn't exist, then it creates it for you. If it does, if that if it does exist, it will fetch it. So it's this idea that you never really have to think about
+2:22
+the accessing your data.
+2:26
+And
+2:27
+so I'm assuming that dendron is putting the is that a YAML? header?
+2:33
+Yes, that is a yamo header.
+2:35
+So it's just automatically doing that when it creates the file.
+2:39
+Exactly.
+2:41
+And for the yamo header, the idea here is we store some metadata. So every node has a unique ID. And the reason we do that is because if you choose to you can publish your notes. That's my local version that this is the engine website is actually a published vault.
+2:59
+Ah, Why. So I created a
+3:03
+workspace with the with the help notes. Yeah. So that's why it looks the same.
+3:10
+Yep, exactly. And it is generated from the notes. And the reason and if you notice the IDs for each note, when you publish the notes are actually published by their ID not by the name. And what's nice about that is even if you've renamed the notes, as long as you keep the frontmatter, it will show publish to the same URL.
+3:29
+Interesting,
+3:30
+okay. And, okay, so, and as I'm battling off, if at any point, you want to just like stop me and say, like, hey, like, what's this? What would you guess? Do you just feel free to I tend to otherwise just keep talking?
+3:42
+Oh, no, that's fine. That's exactly what I was hoping. Okay,
+3:45
+okay. Um, so creating, so as far as creating notes, you can type it. If it exists, it'll fetch it. If it doesn't then it it will create a another way of creating notes as using wiki links, which is double bracket syntax. So for example, if I wanted to go to Ruby, I could type in Ruby. And then if you do the go to definition shortcut, then you can go to default on Mac is something different. I just changed it to Ctrl, enter. So if I do Ctrl, enter, I can go into Ruby, sometimes some markdown preview, well, like, not update right away. But in, for example, in groovy, I can type in Python, and I can go here and I can go back to Python. And making these links, it's kind of the same thing as look up in like JavaScript, for example, JavaScript doesn't exist. But if I navigate to it, then venturing well creatively.
+4:42
+That's kind of the same way obsidian works.
+4:47
+And it's just this idea that you shouldn't be thinking about the order of files. It's, you know, not likely and notetaking should just be the information that you're working with. And as far as bi directional linking On the left hand panel, so we have a backlink section. And the backlinks section shows you all the notes that this note is linked by. And so in Python, it's showing you that hey, Ruby links do Python. Yep. And I think obsidian has a similar panel, but it's, yeah, it's a backlink panel. Now, the thing that Oh, and I guess one more thing before I get into hierarchies, we support let's see, this is header one.
+5:35
+This is header Two,
+5:39
+one.
+5:43
+So denisha. We also support what we call defences, loan costs and block graph. I think loan costs and block references. We call them nodes references. I think obsidian also has a doe I'm not sure what they call it.
+5:58
+I don't actually have this Same. There are references to headers and things, but they don't. It's a little different.
+6:07
+Right? So what I'm going to show you is in dendron, you can embed notes and other notes. So for example, I just hit Command Shift R, which copy the left lens of this note, and the, and then I can paste it, for example in JavaScript. And so I'm seeing the Python notes embedded in the JavaScript note. You can either choose to reference a note, or you can choose to reference a header. So for example, everything starting from heading one, and you can also do games. So you can say everything starting from header one to header two, that you can embed notes into other nodes. And then the other thing that you can do is you if you keep bullets, the markdown preview is mutable in the sense that you can click on the lead and also update the markdown. Yes, that's a little thing that I find people get quite excited about that
+7:08
+over if you're going to use to do if you're going to use those
+7:10
+as to dues it's a big deal. Exactly. Um, okay, and now getting to the part. So right now what I've shown you it's pretty similar to obsidian it's pretty similar to go more like how normal note taking apps work. The things that dungeon the dungeon now starts doing differently is we're focused on having your notes conform to some sort of structure. And so that's not to say like, as you can see, like we support backlinks so you can link any note to any note. But the problem that I found and the reason why I made my own note taking tool is I find that once you get a lot of notes, you need some sort of structure, if you organize it, if it's all backlinks, like it becomes really hard to find something, whether it's a naming convention, whether it's some sort of hierarchy, like there need to be some sort of structure to help you find it. And so in Benjamin, for us that structure is hierarchy. So the way that you create a hierarchy, and Benjamin is whatever. So when you do command L, you the lookup bar gets populated by the current note that you're in. And so if you have not, then you're creating a new level in the hierarchy. So for example, I can do Python data. And so you know, this is a data node. But the hierarchy is, Python is parents data as a child. And under data, for example, I might want to do if I'm learning about Python, data could be you know, all of the various data structures that Okay, my path and setting I can look in billions and things. And the nice thing about this hierarchy is now instead of, you know, you manually having to link all the nodes together, because you are in the Python hierarchy, you can you have a bird's eye view of everything in this hierarchy.
+8:59
+That's just kind of Gaining
+9:02
+interest. Another way you can see the hierarchy is we have to show graph command. And so just like how obsidian has a graph, Python, now Python engine has a graph. But this is a graph with backlinks. It's a graph of your hierarchy. And so, you know, as you note, like there isn't a connection between Ruby and Python, even though there's a backlink, what this is showing you, you can think of it as a top down view of your table of contents of the hierarchies that you have. Right. Now, the nice thing about having this is like right now, for example, Python this in stone thing, that web engine lets you do, so let me back up for a moment. hierarchies, I find are one of the best ways of organizing notes by most people and most tools don't really support it as well. And that's because I think not because hacky some work, but because he had no tooling on our piece. Like if you had your files in a folder Actually, you could put them in a bunch of different folders, but then like finding them is more difficult. And then if you ever wanted to rename anything, that's just a nightmare. And so attention, we're building on this idea that it is actually some of the most effective ways of managing information with people. And we it's built around this idea that as hope you work with hierarchies, and one thing we let you view is we let you be factor. So for example, right now, I'm under a Python. But let's say that I shut off a entering text I want to replace. So I'm saying for Python instead of Python. Oops, let me again, instead of Python, go place Python with Lang Python. And what this is going to do is everywhere where you have python.md, it's going to add the Lang prefix for programming language. And if I hit proceed, proceed. What you'll notice is that not only did all the falaschi name but also If I go, for example, into movie, all the links to the palace, and also then. And so it's just an easier way of managing the hierarchies. And now, like, why might you want to do this? Well, because I have this just crazy thing. So because I have this programming language it, what it lets me do. And this is really what I started doing with my notes is, if I'm learning, for example, a programming language, and I'm working on like two or three at a time, it's really difficult to context switch between them. It's like, how do we do this in Ruby, how you listen to Python? What I found was much more conducive is if I could think like, okay, in a programming, what is my model for programming language. And so for example, a programming language has data structures, and so I could apply that to Ruby as well. So for example, for Ruby, it also has data structures. And then what I could do is when I'm learning about Ruby, you know, I could translate that higher He that I learned from Python, and put it into a movie. And what this lets me do now is, now it's a lot easier to context switch between different programming languages, because I'm thinking more about the concepts than the actual implementation. And for example, now, if I'm like in my hierarchy for So first of all, like, if I'm looking at data structures in Python, I have all of them in one view. But now let's say that I want to look up data structures for all my programming languages, then I also have a similar view for that. And so now, this idea, and this is where it really, for me, like, became like, the way that I did all my notes is having these hierarchies not only are they a great organizational scheme, because now instead of having 100, you know, 1000 notes at the top level, you only have, you know, the very good stuff behind this. So it's programming languages. It's cooking as you know. Few things that you care about at the top level, and you can drill down into them. And when you drill down into them, it's not just organizational. It's something that, for me, at least, it helps me learn about the topic. Because I find the heipiess that I create, for, you know, a programming language or anything, they affect my mental model of it. And I find over time, when I'm learning about things, it's not actually the implementation that matters, but it's the fact that I've been able to develop this hierarchy and then continue refining it over time.
+13:34
+That makes sense. Well, there's nothing that keeps you from just having a bunch of loose notes at some, somewhere even if, even if it's nothing. If for the sake of cleanliness, you you create a hierarchy starting with Miss and stuff under it. You have the same thing you have typically totally get the language thing. I once had a situation where I had the word two computer assembly languages. Yeah. And one of them had right to left operation on the instructions. And the other had left to right, but three quarters and now, three quarters of the names of operations were the same. So you just had to remember whether you were in left, right or right, left. So yeah, I totally get that.
+14:28
+And the other thing that I do for these notes, and let me just going to show you this is my one of my vaults. This is a notes for a meeting today. But for example, I have a CI and this is like all the CI commands that I run into, and it's not just necessary. Oh, okay. So that one. It's like, if I run into a problem instead of, you know, googling it,
+14:55
+yeah.
+14:56
+I don't know how half a cache of it. So if I run into the same problem, they And, you know, I can just go into that COI hierarchy.
+15:04
+And right because it's the one, it's the one. I did that last month. I know I know that, but I don't remember.
+15:12
+Exactly. And if you look at this, I think I have a couple of hundred different commands. And the nice thing about this as like, I did none of this, you know, ahead of time, it was kind of a just in time, I ran into cognitive work. I needed to Stack Overflow, it took me 10 minutes. I never want to spend time on it again. Let me go into, you know, yeah.
+15:36
+Okay, cool.
+15:38
+So, can we look a little bit at, um, kind of your to dues?
+15:44
+Yeah. So, two dues let me actually, okay, I'm going to do two things. I'm first going to show you how you would create it from scratch and then I'll show you my two dues for the day. I like to organize things by projects. And so I usually have like a project hierarchy. Actually. And so for example, one project might be different. And so under dendron, what I actually do is I have a daily journal that I go over everything I need to do for that particular day. And let me think, what is the best way of showcasing, I'm just going to show you my to do actually.
+16:28
+So this is my to do for a dendron.
+16:32
+And let me show you and the video. And what I do is intention, you have this notion of your journal notes. And so journal notes is basically whatever hierarchy you're currently in, and appends journal to it in the current date. And this is configurable. You can change the date format, you can change how it appends it, but I'm going to move on to tomorrow's date. And the way you do that is Ctrl Shift J. But you can use that to create a new Going on it. And then what I do is every day, are you familiar with snippets inside VS code?
+17:07
+Oh, I haven't used them inside VS code. I use external snippet code.
+17:14
+Well, I, anyways, I use a bunch of snippets. And so apprehension journal snippet, and that will fill it out with
+17:21
+Okay, might get the idea even though I haven't used it.
+17:25
+Yeah. And then the way I do two dues that's worked really well. For me, if I'm just working by myself, I have a snippet to make this bullet. And then I'll write you know, task one, task two tasks week.
+17:38
+Something that
+17:40
+dension does fairly well is for example, sometimes like past one, it turns out to be a much bigger task and has a notion of sketch notes. And so let me and so this is all just special cases, it's you can create a sketch note by Command Shift s, and you can choose to add a title or not. If you don't add a title by default. It creates under your current high hierarchy denture and dots batch, and then the current date and timestamp. And you can think of this cache notice as caches, it's just, oh, I'm in a meeting, I need to take a note, I don't want to figure out where I'm gonna move it. So I'm just going to start you know, taking. And so that's kind of the purpose of discussion. And then later on, you can like rename it, and then follow it away somewhere if you want to. The more interesting thing is, if I highlight tasks, for example, and then I do the shortcut for a sketch note, what it does, is it creates a link from this task to the sketch note. And so now, you know, I can use this to create nested tasks. So you know, task 1.1 1.2 and if I find that, you know, task 1.1 is still too big, and I need to break it down even further. I can create another cash flow from that and then you know, create even more tasks. So you can go as deep as you want to that I usually find that to be To TCP level sign up yeah
+19:04
+that deeper probably needs to be broken up
+19:08
+and but what's really cool about this is you can start off with a bullet and you can still keep this nicely bulleted list but then you can you know, expand upon it as much as you need to. Um, but as far as like project management goes the way I manage projects is I have my daily to dues and then I look at my to dues from the previous day. And then like anything I haven't done the previous day, I will copy it over into today. And then I will I use a bullet journal format so like I will add like a lesson sign.
+19:47
+Go No, I don't use it, but I'm familiar with it.
+19:51
+And something else that you can do is this is VS code feature more than attention feature better And then most people don't know about this. If you notice, for example, I have tags to some of my tasks, what I can do VS code has a search editor feature where you can search within your current note. And so if I type in start, it shows me For example, all my lines were have to start counting. And what's cool about this is this search is globbing. And so what I can do is by I have this shortcut set up, that brings me a search of whatever the current notice, but I can, for example, go here to show me Okay, what are all my past titled start within this month? And this shows me all of that materialized in a single view. All right, go What is everything, you know, in this year, or, you know, it's a quote skyjack so you can get as fancy as you like, and what what I will say this like this search, edit I view it's a VS code thing, not an engine thing, but it's Because the engine, if you follow dingemans method of putting stuff in hierarchies, it makes us search things super powerful, because now you can glob and search within. Yeah, the big dates. You can, for example, if you think back to a programming example, in Python, you can search, you know, under Python, everything in Python that has a gotcha tag, or everything in programming languages, that was hard. And that is something that you get for free with the hierarchy. This is nicely structured, being able to just search everything within that.
+21:38
+So what's really fascinating about this for me to watch, is that the name that you get, which is the hierarchy with with dots as separators on the mainframe, that's actually how hierarchical folder structures are achieved. Yeah,
+22:01
+that exact naming convention.
+22:04
+Nice. I haven't had the pleasure of using many mainframes in the days.
+22:09
+Yeah, so that was that one harks back, like decades for me. Okay.
+22:14
+Um, so I have an unrelated question, what is the tool you're using? That's echoing the keystrokes. And that's actually VS code. So VS code has something called screencast mode. I'll go ahead, it will show you all the keystrokes.
+22:29
+Cool. All right.
+22:31
+And that's a nice thing about building engine inside VS code is that, for me, like what was different about attention and what the thing I'm trying to promote is this idea of keeping your notes in a hierarchy and giving you the tools to work with that hierarchy. But then all the other stuff, for example, like being able to work with markdown and supporting multiple panes and having all the other stuff that you need in an editor. It's not really differentiating and you codecademy is a great place for that. And plus you have all the extensions. And VS code has and VS code has like a lot of new features. One of them another one that I really like that I find most people don't know about is you can toggle lines. So if you do option, arrow key, you can move lines up and down. And I find that really nice for prioritizing because I usually like to, you know, keep stuff in this sort of format. And this way, I can easily move stuff down when I'm done. And what's cool is it's not just a single line, you can highlight a whole block and you can move that whole block at a time. But it's just another one little known feature that I find it makes a big quality of life. Yeah.
+23:48
+Let's see.
+23:51
+Um, this. That's the other thing that you can do. indention is you can paste images. I find that's a question I get a lot specially with Mark And so I use a program called sketch, which lets me take a screenshot of the screen. And then if I do Command Shift C, it puts that image into my clipboard. And then inside address, you can kinda paste image command, which will take whatever is in your clipboard, put it in this path in the vault. And then now you have the picture. And I find that useful because I in markdown paste ads at night, adding media is usually like a problem that people have.
+24:32
+Yeah, obsidian handles that pretty well, much the same way. So yeah, that one I haven't had a lot of friction on.
+24:41
+And
+24:42
+that's really interesting.
+24:45
+Yeah, the hierarchy is definitely the thing that I am working upon. And oh, one thing I haven't shown you and this is more of an advanced feature, but you can create schemas for your hierarchies and you can think of femurs is kind of being able to type check. And so I'll show you what I mean by that. So right now I'm creating a lens. And the way I go to schema is I do Command Shift L. And this shows me all the schemas that I have. So it's kind of lookup, but instead of looking for markdown files, I'll explore YAML files. And so your schema, it is just a yamo. And it follows. And what it does, so is it says that, okay, there is a node that is named. And so Lang is the root of your hierarchy. And you can, for example, say that this has children. So for example, Python, it's Ruby. And the only thing you need to specify for the children is that they exist. And now you need to reload the index between schema changes because it hasn't picked up on Live, that's going to change later. But now, if I go into my lookup, if I type in Lang, for example, you'll notice it's actually a little book to it. And the little book over here means that hey, Lang is part of the schema. And if I go down, I can see that Oh, like there's a little book next to Python. That's part of the schema. If you look at JavaScript, because I created
+26:31
+it. It's not in the schema, if you look at Java, this little question mark, because it's not in the schema. And the reason you might want to do this is for example, like as I'm building my hierarchy, oh, one thing is you don't have to like enumerate everything. So this a namespace property where you can say this is a namespace. And so now, this is essentially saying that this is going to match now Not start the globbing pattern. The scheme is just based off this simple globbing pattern
+27:06
+that would pick up if it existed.
+27:08
+Yeah. And so now if I go to Java, this little book to it, because that's in a sec, okay, I recognize it. Now, the interesting part here is now for my children, for example, if I say data,
+27:21
+so data structures,
+27:24
+and you know, and data, let's say that as their children, like, spring, I have a lot of different autocompletes. So that Well, sometimes,
+27:38
+yeah, no, I know how that works. I get that a lot. Yeah.
+27:43
+So let's say that I crave
+27:46
+that. And so this schema of the way that the globbing patterns work is the children will inherit the parents as a prefix. So this will match Lang dot star dot data. And then string will match Lang dot star dot data watchman. But the schema is also hierarchal. And so now, if I reload my index, if I go to lang.db, dot away, for example, there's a book, because it's part of my schema. But if I look into your data, that Boolean does nothing, because it's not part of my schema. And schemas are really lightweight. It's just that yamo and we don't stop you from creating things outside of your schema, we just show you a question mark. But it's nice. For example, if you're building a programming language hierarchy, and just like sometimes use Google, sometimes use Boolean and you want to keep it consistent, you can document it in your schema. And the engine will also tell you when you're going outside of it, and in the future, we'll add options if you want you to actually enforce it. So you can say like, hey, like, actually don't have any great things that go outside of this. Okay? And that's just because like if my this is how likely entropy builds up and up looks like you name one thing for one fee and then another one for another, and then you have a million different things.
+29:07
+Yep, I have, I have several backlinks that I have to go clean up because I did somebody's name or title or something differently in two different places.
+29:20
+l and schema strike now. We are also this going to be more features that you can do with schemas. And right now, it does two things. One is it gives you the little book with a little question mark, if you're in a note that matches it. The other thing is you can assign templates to it. So for example, for this thing, I can say that it has a template. And what that means is when I create a note that matches the schema, automatically apply this template to it. And so the idea of this template is going to be the name of another note. And so for example, if I just do a Lang, template, M and M Then I can say this is something inflige. And it's a note template. And the reason you have this this in the future will have different types of templates, you can make templates from snippets, or other sources. And now if I reload my index, and let's create a screen for something I don't have fishing for so let's say Lang dot java data archwing. And oh, something else that schemas that you do is it autocompletes so like, even though again, string haven't been created, it shows you Hey, this matches the dang schema. According to that schema, you happen assumptions.
+30:40
+Nice. So if I type in train,
+30:46
+it shows you how demos will always break your hearts.
+30:52
+Of course,
+30:54
+that's me.
+30:57
+delete this. So Command Shift D is to do Return note.
+31:03
+And
+31:06
+let's try this again. I might have to reload the window for it to pick it up. So, let me I just reloaded the window. I'm going to delete this and then try to create it one more time. And then hopefully, but
+31:26
+Okay, I'll look into that. But so yeah, yeah, yeah. Okay.
+31:37
+And there are other things, but these are essentially like the core parts of dendron. Something else that you can do is you can take your notes, and you can publish it to GitHub. So that's a build command. Right now, because we're in an empty space, you need to run another command to add in some pals, but basically what that when you do build power On a workspace is that it can, it'll generate, it'll turn it into static files that you can publish to GitHub. And it'll have the same template as an engine website. Um, and it's also hierarchical. So you know you the same hierarchy you happen engine you can have on your website, you can choose to publish either everything in your vault, or you can choose which hierarchies you want to publish. And then the other thing is this search bar here. This is actually also path based. So the same lookup mechanism that you use insight engine, you can also use on an engine website.
+32:42
+Nice. Yeah.
+32:43
+Cool.
+32:44
+Yep. Well, thank you. Yeah, no problem.

Added: vault/dendron.ref.zen.md

Files changed (1) hide show

vault/dendron.ref.zen.md +11 -0

vault/dendron.ref.zen.md ADDED Viewed

@@ -0,0 +1,11 @@
+---
+id: 97b90ae4-fedb-4927-bf3f-7f9fc472a939
+title: Zen
+desc: ''
+updated: 1604235708979
+created: 1595341882454
+---
+## On Hierarchies
+Rigid hierarchies can result in friction to getting thoughts in but having no hierarchy can be problematic in getting notes back out. Dendron tries to walk the line by letting you create links between any two arbitrary notes but also layering on top a flexible hierarchy that lets you prescribe a canonical organization of your notes. See more thoughts on the matter [here](https://www.kevinslin.com/notes/e9c72b4f-adb8-4f15-a6aa-9f9d81538561.html).

Added: vault/dendron.release.2020-07-25.md

Files changed (1) hide show

vault/dendron.release.2020-07-25.md +131 -0

vault/dendron.release.2020-07-25.md ADDED Viewed

@@ -0,0 +1,131 @@
+---
+id: 6aed338c-df05-420d-aa7b-59dfd2214349
+title: Release Notes(version 0.4)
+desc: ''
+updated: 1609990780194
+created: 1595984607502
+date: 2020-07-25
+---
+Its been an active week of Dendron development. These weekly release notes are to keep you up to date on some of the things we're working on.
+These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
+## Legend
+- 🚧 experimental
+## Features
+### New Getting Started Experience ([dd4f50e](https://github.com/dendronhq/dendron/commit/dd4f50eb169e7f9686c4e3fbabca3b2a6c1e1bb7))
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dendron-quickstart.gif)
+Dendron has a completely re-done getting started. you can see it by running `> Dendron: Initialize Workspace` in a new workspace and then navigating to `dendron.quickstart`
+### 🚧 Graph View for Hierarchies ([129bf4e](https://github.com/dendronhq/dendron/commit/129bf4e4e480dfbff66530725c6db8d2321adc28))
+- [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.graph-view.md)
+Note that Dendron's graph view lays out your notes according to their hierarchy (vs backlinks).
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/graph-intro.gif)
+### 🚧 Windows Support ([a789ec5](https://github.com/dendronhq/dendron/commit/a789ec5792301103d302739f00b595509128d367))
+Dendron is now compatible with windows
+### Upgrade Settings Command ([c043090](https://github.com/dendronhq/dendron/commit/c0430905d314c6ee870f9bdd45434f53e93a7098))
+- [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.commands.md#upgrade-settings)
+Dendron will automatically update your workspace settings during version upgrades to make sure they stay up to date with new features and bundled extensions. If you've modified the settings or want to restore your settings back to their default, you can run this command.
+### Reload Index Command ([236b2ac](https://github.com/dendronhq/dendron/commit/236b2ac70812c4df525ff27479802b6e49e0587f))
+- [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.commands.md#reload-index)
+Dendron will re-initialize the index. This is currently necessary if you add new entries to a [schema](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.schema.md). Otherwise, Dendron will re-index schemas the next time you reload/open your workspace.
+### Open Logs Command ([4f223fc](https://github.com/dendronhq/dendron/commit/4f223fc318fe033471252611c8f41d505dca1055))
+- [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.commands.md#open-logs)
+A bunch of you have been submitting issues to our issue tracker. To make the process easier, we now have a command to automatically fetch get the logs for when you submit your next issue.
+### Open Link Command ([7f630d1](https://github.com/dendronhq/dendron/commit/7f630d1fb95d5c0d28fc5a83f4cee27bc17d452c))
+- [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.links.md)
+Be able to open non-markdown files using native apps (eg. use preview to open pdfs on mac).
+### Journal Notes ([5e1236f](https://github.com/dendronhq/dendron/commit/5e1236fddbf1e0fddf4c27d1a40e9841cc99974f))
+- [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.special-notes.md#journal-note)
+A journal note is a self contained note that is meant to track something over time. Examples of journals include recording workout sessions, making meeting notes, and keeping a mood journal.
+### Scratch Notes scratch ([71d8433](https://github.com/dendronhq/dendron/commit/71d8433fbd10651ec7fcd13a5f7ee41199a43632))
+- [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.special-notes.md#scratch-note)
+A scratch note is a self contained note that is meant to be used as scratchpad. Use it for thoughts or when you want to expand on a bullet point. Scratch notes are created in the `scratch` domain and have the following format: `{domain}.journal.{Y-MM-DD-HH-HHmmss}`.
+## Fixes
+### Markdown Preview will now Open Local Links ([9a3418](https://github.com/dendronhq/dendron/commit/10a3418f7a633fa9b5294794e1a912cb4ea6c066))
+Issue were the newest VSCode broken links. This fixes that.
+## Enhancements
+### Reduce Startup Speed ([4502e49](https://github.com/dendronhq/dendron/commit/4502e49f79d490bb639d2daaf93f841e5b18449d))
+Use webpack to reduce bundle size and reduce startup speed by factor of 10
+### Remove Extra Frontmatter ([e059346](https://github.com/dendronhq/dendron/commit/e0593467fca94a4d29dc9463721a99e67881cfb3))
+- [docs](https://github.com/dendronhq/dendron-template/blob/master/vault/dendron.topic.frontmatter.md)
+Dendron keeps track of metadata to your notes using frontmatter. There were many fields that we wrote out that didn't need to be written out because Dendron gathers that information during its index phase. Those fields are now no longer written out!
+### Initialize Default Workspace with Relative Paths ([790ef50](https://github.com/dendronhq/dendron/commit/790ef503225e5b18a78e3e62e847ba8b2adfd8d0))
+By not hardcoding the workspace path, it makes it easy to use Dendron between different devices.
+- change workspaces accepts '~' path ([d6c4f64](https://github.com/dendronhq/dendron/commit/d6c4f64cdfbb9e6b5c44a04320a84756fefcb924))
+- creating journals copies path to clipboard ([a34fc81](https://github.com/dendronhq/dendron/commit/a34fc815454e0e86112d5a507dd0013ec37a0edb))
+- automatic setting upgrades ([ae74675](https://github.com/dendronhq/dendron/commit/ae74675ab05f8b4ff579311850817c434e23ec94))
+- keyboard shortcuts for scratch and journal notes ([076fa18](https://github.com/dendronhq/dendron/commit/076fa18ceb0836736e123d7439af31da00cc2ec2))
+### Initialize New Vault With git ([7278b6f](https://github.com/dendronhq/dendron/commit/7278b6fbbf4e175815a0a069c449ad7ef479a77e))
+Dendron will now initialize a git repository when you run `Initialize Workspace`
+### Example Video
+Dendron now has an example video. You can watch it [here](https://youtu.be/6rwWUalr9Ac).
+## Next
+Some notable items we are working on for the next release. You can see the full roadmap [here](https://github.com/orgs/dendronhq/projects/1). You can join the discussion on upcoming roadmap items in our [#roadmap discord channel](https://discord.gg/HzkFcs).
+### Refactor Hierarchies
+- [issue](https://github.com/dendronhq/dendron/issues/39)
+Be able to refactor hierarchies and have all file names and links automatically update.
+### Publish to Github Pages
+- [issue](https://github.com/dendronhq/dendron/issues/60)
+Be able to publish a vault as a github page
+## Thank You
+Last and most of all, a big **thanks** to all these people that contributed issues and suggestions during this release.
+- [Alexis Argyris](https://github.com/alexisargyris)
+- [Jay A. Patel](https://github.com/jayp)
+- [Kiran Pathakota](https://github.com/kpathakota)

Added: vault/dendron.release.2020-08-02.md

Files changed (1) hide show

vault/dendron.release.2020-08-02.md +175 -0

vault/dendron.release.2020-08-02.md ADDED Viewed

@@ -0,0 +1,175 @@
+---
+id: e32aa1e2-9780-4183-927e-2f46372050aa
+title: Release Notes(version 0.5)
+desc: ''
+updated: 1609990774348
+created: 1596374984386
+date: 2020-08-02
+---
+With the coming of August, 2020 is officially on the wane. I think many of us are ready for a fresh start. In the meantime, you can prepare for better times by playing with new Dendron features. Happy gardening! 🌱
+With this release, we are also conducting our first dendron user survey. It's a short survey that should take no more than 3 minutes to fill out and will help inform me on the future growth of Dendron. Your participation is immensely appreciated 🙏
+<https://forms.gle/PPqe2axvwEmpXj4v5>
+These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
+## Legend
+- 🚧 experimental feature
+## Commands
+Dendron has a series of built-in commands. They are all prefixed with `Dendron:` and can be accessed through the [command prompt](https://www.dendron.so/notes/c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50.html#command-bar).
+### Add Doctor Command
+([d4fa71c](https://github.com/dendronhq/dendron/commit/d4fa71cd839782587d47a3ba1b0f7e89742e7ffe)) ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#doctor))
+This makes sure your workspace is up to date. It will execute the following actions:
+- add ids and titles to the frontmatter of all notes that are missing it
+- setup a `docs` folder if it doesn't exist. Required if you want to [[publish|dendron.topic.publishing]] your notes
+<a href="https://www.loom.com/share/bd045f708f8e474193de8e3de0dc820f">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/bd045f708f8e474193de8e3de0dc820f-with-play.gif">
+</a>
+### Add ShowHelp Command
+([ecf3c68](https://github.com/dendronhq/dendron/commit/ecf3c6822848834d9a00e373d1c59b6628e7f4df))([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#show-help))
+Dendron will open your current browser to the [[quickstart|dendron.quickstart]] page.
+<a href="https://www.loom.com/share/b81ce02f30b84d79b92584f339184a00">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/b81ce02f30b84d79b92584f339184a00-with-play.gif">
+</a>
+## Pods
+Pods are the mechanisms Dendron uses to import and export notes. Dendron has a different pod depending on where you are getting and publishing your data to.
+### 🚧 Support Publishing Notes
+([e063732](https://github.com/dendronhq/dendron/commit/e063732d1ff082dd8520a479926e7ceb1b0893ab)) ([docs](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html))
+Dendron lets you publish the contents of your vault, either in its entirety or only a subset. Notes are published under the [dendron-jekyll theme](https://github.com/dendronhq/dendron-jekyll).
+### Features
+#### Nested Hierarchies
+dendron-Jekyll supports the same nested hierarchies as your notes and allows you to navigate via the sidebar.
+<img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-hierarchy.gif" />
+#### Lookup
+If you'd rather not click, dendron-Jekyll also supports path-based lookup.
+<img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-lookup.gif" />
+#### Permanent Ids
+Every page is published using its unique ID which means that URLs will never change, even if the filenames do.
+<img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-ids.jpg" />
+#### Free hosting, custom domain names and SSL Certs
+If you have a free GitHub account, then you can host your Dendron notes for free using [github pages](https://pages.github.com/)
+<img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-domain.jpg" />
+#### Jekyll Liquid Tags and Variables
+- NOTE: this will only be "compiled" in the published site but won't be rendered in the regular markdown
+<img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-liquid.gif" />
+#### Selective Publication
+You can choose to publish your whole vault or a single domain within your vault.
+- NOTE: It is not currently possible to publish multiple domains. If you would like this feature, you can vote for it [here](https://github.com/dendronhq/dendron/issues/64).
+### Setup initial workspace to be ready for publishing
+([e1242b4](https://github.com/dendronhq/dendron/commit/e1242b494cc91b3284053b54dccecc4e4686ab7d))
+All workspaces created from Dendron `0.5` onwards will have all the necessary configuration pre-loaded for publishing.
+## Schemas
+Think of schemas as an **optional type system** for your notes. They describe the hierarchy of your data and are themselves, represented as a hierarchy.
+### Enable lookup for Schemas
+([19b4677](https://github.com/dendronhq/dendron/commit/19b46770fe6a842831692563de96ff4a823df871)) ([docs](https://www.dendron.so/notes/a7c3a810-28c8-4b47-96a6-8156b1524af3.html#schemas))
+The process for finding schemas using Dendron is the same as that for finding notes. One lookup to rule them all.
+Find Schema
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-lookup.gif)
+Create Schema
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-create.gif)
+Delete Schema
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-delete.gif)
+### Schema Templates
+([0205d66](https://github.com/dendronhq/dendron/commit/0205d66fc4538361322ffeabb3e532f0d541b775)) ([docs](https://www.dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#schema-templates))
+Schema templates let you specify a pre-defined template that will automatically be applied to all notes that match the template. You can see a video of how this works below.
+This is extremely useful whenever you want to re-use the outline of a note. Examples include daily journals, weekly shopping lists, and weekly reviews.
+<a href="https://www.loom.com/share/481b7ab051394c1caa383383bd265755">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/481b7ab051394c1caa383383bd265755-with-play.gif">
+</a>
+### Simpler Schema Syntax
+([d53ddb](https://github.com/dendronhq/dendron/commit/d53ddb73bfacc3f769db88cfd4f482a706dcb6dd))
+Schema syntax has been simplified. Before we had an extra `data` field to namespace the `namespace` field. We flattened all schema attributes to make the syntax more elegant. Note that the old styled `data` syntax is still supported but we recommend moving to the new syntax as `data` will be deprecated in a few releases.
+## Fixes
+Bugfixes for this release
+- Fix issue with Journal Names on Windows ([d0bfe7f](https://github.com/dendronhq/dendron/commit/d0bfe7fb0288e8610fc4b177ee85697a8ebc3efe))
+- Stub nodes should keep parents when deleted ([f32f291](https://github.com/dendronhq/dendron/commit/f32f291bc7a1ddd6c542483730e2db74b400dafa))
+- Issue with Urls in published site ([0ac8e75](https://github.com/dendronhq/dendron/commit/0ac8e75c95a9c4760e12bb301fc5b66b011ef0fb))
+## Enhancements
+- CI/CD testing ([d6ce68c](https://github.com/dendronhq/dendron/commit/d6ce68c720d7e8c96d7f4bb6ab390c1bd52c5218))
+  - Dendron now has continuous integration tests for all pushes. ![](https://travis-ci.com/dendronhq/dendron.svg?branch=master)
+  - Tests run on mac, linux and windows which means moving forward, there should be fewer OS (aka Windows) related issues
+- Update [quickstart docs](http://localhost:4000/notes/e86ac3ab-dbe1-47a1-bcd7-9df0d0490b40.html)  to showcase new features ([aec0fe0](https://github.com/dendronhq/dendron/commit/aec0fe0939239d84f5b7ebd9ebae57a09bcdae43))
+## Next
+A teaser of some items we are working on for the next release. You can see the full roadmap [here](https://github.com/orgs/dendronhq/projects/1). To join the discussion on upcoming roadmap items, check out the  [#roadmap](https://discord.gg/HzkFcs) channel on Discord.
+### Refactor Hierarchies
+- [issue](https://github.com/dendronhq/dendron/issues/39)
+Be able to refactor hierarchies and have all file names and links automatically update. This was supposed to go out in this week's release but there are just a few items left that need to
+### More Templates and Examples
+Many of you have asked for examples of how to best use Dendron. We will be publishing a list of such demos on [Dendron](https://dendron.so)
+## Thank You
+Last and most of all, a big **thanks** to all these people that contributed issues and suggestions during this release.
+- [Alexis Argyris](https://github.com/alexisargyris)
+- [Gustav](https://github.com/Whil-)
+- [Jochen Burkhard](https://github.com/herop)

Added: vault/dendron.release.2020-08-09.md

Files changed (1) hide show

vault/dendron.release.2020-08-09.md +100 -0

vault/dendron.release.2020-08-09.md ADDED Viewed

@@ -0,0 +1,100 @@
+---
+id: 075e9806-0367-40a2-8154-2e84d5a020e2
+title: Release Notes(version 0.6)
+desc: ''
+updated: 1609990768070
+created: 1596374871110
+date: 2020-08-09
+---
+Another week, another minor release. The much asked for `Rename Note` command is here, as well as a bunch of enhancements to notes and schemas. Enjoy 🌱
+This release is also a reminder to fill out the [Dendron user survey](https://forms.gle/PPqe2axvwEmpXj4v5) if you haven't done so 🙏. This is a super short 3min survey that will help me plan the future growth of Dendron.
+These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
+## Commands
+### Add Rename Note Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#rename-note))
+Do you have regrets? While there are some things that you can't take back, misnaming a note should never be one of them. Dendron now lets you rename files and will update all links in all files that link to it!
+![rename](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command-rename.gif)
+### Add Copy Note Link Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#copy-note-link))
+School's out so it's okay to copy notes. Use this to get the wiki-link (with title) of the current open note.
+![copy note link](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command.copy-link.gif)
+### Enhancements
+- Show feedback on copy note link
+### Fixes
+- Issue with renamed notes not being indexed
+- Issue where `doctor` doesn't backfill newly created notes'
+## Notes
+### Flexible Configuration for Notes ([docs](https://www.dendron.so/notes/5c213aa6-e4ba-49e8-85c5-1bdcb33ce202.html#configuration))
+Notes are now as flexible as your yoga teacher. You can now customize every aspect of your `Journal` and `Scratch` notes - how they are added, their time format and even what they're called
+### Add Built in Snippets ([docs](https://www.dendron.so/notes/9eca1992-7540-4d9d-97fb-328b27748b2c.html))
+All the one-liners and bad jokes that you have saved for that special someone? Type them out faster than ever with built-in snippets. This updates the default settings to allow tab-based snippet completion and also initialize new vaults with some default snippets.
+![snippets](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tab-autocomplete.gif)
+### Enhancements
+- Copy on Create: Journal and Scratch notes will automatically copy their links to the clipboard after creation
+### Fixes
+- Scratch note title note being set properly
+- Not all notes indexed in sparse vaults: There was an issue where certain notes without a full hierarchy would not be indexed by Dendron. That issue has now been eliminated.
+- Notes created via link not being indexed properly: Issue where sometimes new notes created using link navigation wasn't being indexed.
+## Pods
+### Custom Blogging Layout ([docs](https://www.dendron.so/notes/4c0ef322-3006-405c-9a66-3134dd9649a5.html#blogging))
+Sometimes you have something you just need to shout out from the rooftops. Because its likely people think that you are a crazy person if you did this, Dendron now has dedicated blogging layouts so you can blog instead!
+### Fixes
+- Issue with buildpod logging
+## Schemas
+### Apply Schema Description to New Notes ([docs](https://www.dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#desc))
+Schemas now automatically apply their description to newly created notes that match said schema. Because life is too short to annotate all your notes all the time.
+### Enhancements
+- Remove data field from new schemas: Schema notes only show you fields that are required on creation.
+## Workspace
+### Enhancements
+- Update index when notes are deleted outside of dendron: We know that sometimes, it can't be helped and you'll need to work with your notes outside of Dendron. If that work is deleting notes, Dendron will now keep track of it and remove it from its lookup index as well!
+## Other
+### Make Dendron available on [Open VSX Registry](https://open-vsx.org/) ([docs](https://dendron.so/notes/9134f160-31a6-4ab0-a640-1fce466f9526.html#open-vsx))
+Maybe you just don't like Microsoft. Maybe you want to see other people. Whatever the reason, Dendron is now available on all VSCode compatible editors like [VSCodium](https://vscodium.com/) and [Gitpod](https://www.gitpod.io/).
+## Thank You
+Last and most of all, a big **thanks** to all these people that contributed issues and suggestions during this release.
+- [Josh Finken](https://github.com/jfinken)
+- [denisdifazio](https://github.com/denisdifazio)
+- Annegrim
+- [Chris Na](https://github.com/buxel)

Added: vault/dendron.release.2020-08-16.md

Files changed (1) hide show

vault/dendron.release.2020-08-16.md +125 -0

vault/dendron.release.2020-08-16.md ADDED Viewed

@@ -0,0 +1,125 @@
+---
+id: 075e9806-0367-40a2-8154-2e84d5a020e5
+title: Release Notes(version 0.7)
+desc: ''
+updated: 1609990760541
+created: 1596374871110
+date: 2020-08-16
+---
+This is one of our biggest releases yet! Support for r**efactoring hierarchies** and **note references** (think Roam's block references) are the highlight of this week's work. Enjoy responsibly 🌱
+These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
+## Commands
+### Add Show Preview Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#showpreview))
+Dendron now has a new command and shortcut to preview your notes.
+### Add Copy Ref Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#copy-note-ref))
+When one introduces note refs, one must also introduce a command to easily copy note refs.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-note.gif)
+### Add Archive Hierarchy Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#archive-hierarchy))
+Wouldn't it be nice to have a magic wand to make all your problems go away? While we're working on that, you can use the `Archive Hierarchy Command` to hide hierarchies that you no longer use.
+<a href="https://www.loom.com/share/9698d5a4451b49d8b107f3ff67d97877">  <img style="" src="https://cdn.loom.com/sessions/thumbnails/9698d5a4451b49d8b107f3ff67d97877-with-play.gif"> </a>
+### Add Refactor Hierarchy Command ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#refactor-hierarchy))
+Do you want to change the past? Us to. And now you can (when it comes to hierarchies). Instead of living with the consequences of bad past decisions (when it comes to hierarchies), you can now change it!
+<a href="https://www.loom.com/share/11d90a86fd1348a5a504406b52d79f85">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/11d90a86fd1348a5a504406b52d79f85-with-play.gif"> </a>
+### Enhancements
+- Rename note will close old note and open the new note
+- Refactor hierarchy will warn you when overwriting files
+### Fixes
+- Allow empty replacements when refactoring
+- Issue where refactor would miss some links
+- Issue with rename notes missing some links
+## Lookup
+### Fixes
+- Issue where new note won't be created if a stub
+- Lookup will exit early on certain inputs
+## Markdown
+### Support for note references ([docs](https://www.dendron.so/notes/f1af56bb-db27-47ae-8406-61a98de6c78c.html))
+Were you roam'ing for a note-taking tool that lets you embed notes and sections within notes into other notes? Well, look no further because Dendron note references are here!
+Link to an entire note!
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-note.gif)
+Or just a section!
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-block.gif)
+Or a range!
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-block-range.gif)
+### Enhancements
+- Update markdown css
+## Notes
+### Enhancements
+- Add 'childofdomainnamespace' to note add behaviour
+## Other
+## Pods
+### Publish Multiple Hierarchies within a Vault ([docs](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#selective-publication))
+You can now publish 0, one, or N number of hierarchies within a vault. We're working on negative and complex numbers of hierarchies for future releases.
+### Ability to not Publish Select Lines ([docs](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#exclude-line-from-publication))
+Unlike what Mark Zuckerberg might want you to believe, people weren't meant to share EVERYTHING with EVERYONE. Use this to keep private lines private!
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pod-local.gif)
+### Fixes
+- Building sites without assets directory throws error
+- Bad title for naked wiki links
+## Schemas
+### Fixes
+- Issue with schemas that have same ids
+## Workspace
+### Enhancements
+- Initialize empty workspace
+### Fixes
+- Remove obsolete info messages
+## Thank You
+Last and most of all, a big **thanks** to all these people that contributed issues and suggestions during this release.
+- [j-steinbach](https://github.com/j-steinbach)
+- [A Howard](https://github.com/runlevelrobot)

Added: vault/dendron.release.2020-08-23.md

Files changed (1) hide show

vault/dendron.release.2020-08-23.md +184 -0

vault/dendron.release.2020-08-23.md ADDED Viewed

@@ -0,0 +1,184 @@
+---
+id: 075e9806-0367-40a2-8154-2e84d5a1110
+title: Release Notes(version 0.8)
+desc: ''
+updated: 1609990753899
+created: 1596374871110
+date: 2020-08-23
+---
+Schemas and pods were the focus of this week's efforts.
+Schemas are now both more powerful and re-usable with a custom `pattern` attribute as well as the ability to `import` existing schemas. As a bonus, you can also visualize your schemas using the `Show Schema Graph` command!
+On the Pod site, we've made the process of publishing a pod more flexible with per hierarchical configuration options, a unified config syntax and automatic reloading of your config on every publish.
+These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
+## Bundled extensions
+### Add ShowSchema Command ([docs](http://dendron.so/notes/587e6d62-3c5b-49b0-aedc-02f62f0448e6.html#dendron-show-schema-graph))
+You can now view your schemas using the same graph visualization as you do your notes!
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/graphs.show-schema.gif)
+### Enhancements
+- Dendron: reload graphs will reload both schema and note graphs
+- Dendron: reload graphs will reload both schema and note graphs
+- Dendron schema graph will show schemas by their title. if not set, revert to id.
+## Markdown
+### Enhancements
+- Markdown parsing can now be up to 300% faster publishing a site
+## Notes
+### Create Daily Journal Note Command ([docs](http://dendron.so/notes/5c213aa6-e4ba-49e8-85c5-1bdcb33ce202.html#daily-journal))
+The daily journal helps you keep a journal for each day of the year. By default, it will create the journal under `daily.{date}` though this is configurable by setting the `dendron.dailyJournalDomain`.
+You can create a daily journal using `> Dendron: Create Daily Journal Note` or `CMD+SHIFT+I` shortcut.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.daily.gif)
+## Pods
+### Support different defaults on a per hierarchy basis when publishing ([docs](http://dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#config))
+You can now set different publishing defaults for each hierarchy (as well as general defaults for your entire vault.)
+As an example, below is the config for [my website](https://kevinslin.com). It publishes everything under the `home` and `blog` hierarchies but will only publish notes under `books` if `published: true` is set on the frontmatter.
+- dendron.yml
+```yml
+site:
+siteHierarchies: [home, blog, books]
+siteRootDir: docs
+config:
+    books:
+    publishByDefault: false
+```
+### Implement new website config syntax ([docs](http://dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#properties))
+New config syntax unifies a bunch of different configuration options and renames others to more sensible names.
+### Enhancements
+- Auto migrate old-style site config to new style site config
+- Always read config before publishing. no more reloading the workspace after updating dendron.yml!
+- Update site config on dendron starter template
+- Use rsync to copy assets when building pods
+### Fixes
+- Use regular copy command if rsync not installed
+- Links not being converted to ids when publishing
+## Schemas
+### Support schema import ([docs](http://dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#imports-optional-str))
+It's now possible to import schemas! This means you can now create composable schemas from re-usable pieces.
+Example:
+- foo.schema. yml
+```yml
+version: 1
+imports:
+- bar
+schemas:
+- id: foo
+parent: root
+children:
+    - bar.bar # notice that we prefix the id bar with the filename
+```
+- bar.schema.yml
+```yml
+version: 1
+schemas:
+- id: bar
+parent: root
+children:
+    - one
+- id: one
+```
+The above would match the following files
+```
+foo.bar # match
+foo.bar.one #match
+```
+### Support match by pattern ([docs](http://dendron.so/notes/c5e5adde-5459-409b-b34d-a0d75cbb1052.html#pattern))
+You can now explicitly specify a glob pattern for any level of your schema. If not set, defaults to the schema `id`.
+The following is an example of a schema for `journal` hierarchy.
+```yml
+schemas:
+- id: journal
+title: journal
+desc: ""
+parent: root
+children:
+    - year
+- id: year
+title: year
+pattern: "[0-2][0-9][0-9][0-9]"
+children:
+    - month
+- id: month
+title: month
+pattern: "[0-9][0-9]"
+children:
+    - day
+- id: day
+title: day
+pattern: "[0-9][0-9]"
+namespace: true
+```
+This will match the following queries
+```
+# journal
+# journal.2020
+# journal.2020.09
+# journal.2020.09.12
+# journal.2020.09.12.foo.md
+```
+### Enhancements
+- Set schema title to id if not set
+- Better error message on bad schema
+### Fixes
+- Autocomplete correctly on imported schema
+## Workspace
+### Fixes
+- A misconfigured POSIX path causes dendron to not load on windows
+## Thank You
+Last and most of all, a big **thanks** to the following gardeners that brought up issues and contributed fixes to this release.
+- [Devashish](https://github.com/ric03uec)
+- [Howard](https://github.com/runlevelrobot)
+- [komoda102](https://github.com/komoda102)

Added: vault/dendron.release.2020-08-30.md

Files changed (1) hide show

vault/dendron.release.2020-08-30.md +126 -0

vault/dendron.release.2020-08-30.md ADDED Viewed

@@ -0,0 +1,126 @@
+---
+id: 1a79e2a1-c906-4ed4-a528-15bd34c4e649
+title: Release Notes(version 0.9)
+desc: ''
+updated: 1609990746697
+created: 1596374871110
+date: 2020-08-30
+---
+This week's focus was on improving the initial Dendron startup experience as well as the overall usability. To that end, we introduced our own tree view, overhauled the getting started experience and created a cheatsheet of all commands (with GIFs of course).
+We also took time to fix bugs and improve performance across Dendron's core features (eg. Lookup, Markdown Preview, etc).
+These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
+## Engine
+### Enhancements
+- Add check to make sure that lookup will throw an error if overwriting an existing file
+### Fixes
+- Sometimes lookup will not return all results on startup
+- Edge case where 'create new' was shown even when note exists
+- Having a naked date in frontmatter could cause lookup to fail
+## Hierarchies
+### Add Go Up Hierarchy command ([docs](http://localhost:4000/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#go-up-hierarchy))
+Go up to the closest non-stub parent of the currently open note.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-up.gif)
+## Markdown
+### Fixes
+- Preview command would fail to load preview
+## Pods
+### Enhancements
+- Throw error on badly formed links
+## Workbench
+### Add Dendron tree view ([docs](https://www.dendron.so/notes/f7ebd4aa-8ba7-4bc5-bd00-a1efc5315f07.html#dendron-tree-view))
+The Dendron Tree View lets you view your hierarchal notes as a traditional folder hierarchy. It has the following capabilities
+```
+- click to open note
+- show indicators for `stub` and `schema` notes
+- show title using tooltip
+- realtime update when you create/delete notes
+- toggle all functionality
+- reveal currently open text document
+```
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.treeview.gif)
+### Show cheatsheet of all commands ([docs](https://www.dendron.so/notes/eea2b078-1acc-4071-a14e-18299fc28f47.html#showhelp))
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.help.gif)
+### Near Instantaneous Lookup 🚀🚀🚀
+Lookup will complete &lt;100ms even as you scale to thousands of notes.
+### Enhancements
+- Don't ignore focus out on lookup
+- Tree view focus on active editor
+- Show collapse all in tree view
+- Treeview tooltip reflect note title
+- Refresh tree view on note deletion
+- Add sort to tree view
+- Keyboard shortcuts don't require editor focus
+- Update default theme to [github light](https://marketplace.visualstudio.com/items?itemname=github.github-vscode-theme)
+- Loading indicator when workspace is first starting
+- Always initialize first workspace with walkthrough
+- Show create new option in schema lookup
+- Better first workspace experience
+- Bundle dendron markdown preview with dendron on installation
+- New welcome screen on first initialization
+- Better lookup results when at root of vault
+### Fixes
+- Remove stub indicator from lookup after note creation
+- Copy note commands will sometimes fail on windows
+- Copy note link could sometimes fail
+- Add no active item picks back to lookup
+- Misleading loading message
+## Community
+### Dendrologist
+We introduced our first Dendrologist this week. [Kiran Pathakoda](https://github.com/kpathakota) has been one of the first to adopt Dendron as his primary note taking platform and will be helping out with the development of Dendron.
+In practice, this means Kiran will be hanging around the discord, help triage issues, and help me put together a more comprehensive public roadmap for the project!
+If you're interested in being more involved with the development of Dendron (and this doesn't have to involve coding), feel free to ping me on Discord or by email at [kevin@dendron.so](mailto:kevin@dendron.so).
+There are a bunch of really exciting things that will be coming out over the next couple of weeks and we will need all the dendrologist we can get :)
+### New Channels
+- \#dev: discuss all things related to Dendron development
+- \#schemas: share and discuss schemas
+- \#workflows: how do you take notes?
+## Thank You
+Last and most of all, a big **thanks** to the following gardeners that brought up issues and contributed fixes to this release.
+- [Jochen Burkhard](https://github.com/herop)
+- [Janne Ojanaho](https://github.com/jojanaho)
+- [Chris Na](https://github.com/buxel)
+- [Daria Vasyukova](https://github.com/gereleth)
+- [Denis Di Fazio](https://github.com/denisdifazio)
+- [nixsee](https://github.com/nixsee)

Added: vault/dendron.release.2020-09-06.md

Files changed (1) hide show

vault/dendron.release.2020-09-06.md +169 -0

vault/dendron.release.2020-09-06.md ADDED Viewed

@@ -0,0 +1,169 @@
+---
+id: 08b2e6ea-bd3e-4f4b-b2b9-676a7b743a65
+title: Release Notes(version 0.10)
+desc: ''
+updated: 1609990740754
+created: 1596374871110
+date: 2020-09-06
+---
+Dendron turns 0.10 today 🌲. To mark this milestone, the pre-amble for this release will be a tad longer (and more sentimental) than usual.
+This week's release focuses on publication and exports. Dendron sites now come with [one click collaboration support](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#edit-on-github), [note references](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#note-references), and [hierarchy hints](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html#nav-based-hierarchy-hints). If publishing online isn't your jam, you'll be happy to know that you can now [export your notes](https://www.dendron.so/notes/66727a39-d0a7-449b-a10d-f6c438185d7f.html#json-pod) to any format you desire (as long as that format is JSON 😅 - more formats coming soon).
+It's now been almost two months since Dendron first went into preview. Since launch, we've passed over a thousand downloads and closed over [100 issues](https://github.com/dendronhq/dendron/issues?q=is%3Aissue+is%3Aclosed) worth of features, enhancements, and bug fixes.
+In that time, we've built an awesome community of Dendrites on Discord now numbering in the triple digits. I feel beyond grateful to everyone that has given Dendron a try in these early days 🌱 and become a part of our budding community.
+Speaking of community, I would like to recognize two new **Dendrologist** - [Fayçal](https://github.com/d3vr) (@bsqrd#9701 ) and [Janne Ojanaho](https://github.com/jojanaho) (@jojanaho#3766 ) 👨‍🌾👩‍🌾
+Dendrologists are active members of the Dendron community that will be helping me shape our roadmap, answer questions, and collect feedback from all of you. If you've spent any time in our discord, you've probably already had chats with one or both of the folks I just mentioned.
+That's all for last week's release. Stay tuned for some big announcements later this week :)
+These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
+## Development
+### Fixes
+- Bad import causes dendron to not compile in case-sensitive file systems
+## Engine
+### Fixes
+- Fix bad sibling traversal cases
+- Issue with mixed case file names
+## Markdown
+### Support offset with note refs ([[docs|dendron.topic.refs]])
+A note reference offset is a way to skip a number of lines when using a note reference. The syntax is `,{number}`. Below is an example of using a note reference offset to offset an initial heading, skipping the actual header when doing the embedding.
+- NOTE: currently, note reference offsets are limited to the first anchor inside a block reference. They must also be a positive value
+<a href="https://www.loom.com/share/31cb62916586453f8475f94ba68b74a1">  <img style="" src="https://cdn.loom.com/sessions/thumbnails/31cb62916586453f8475f94ba68b74a1-with-play.gif"> </a>
+### Enhancements
+- Note refs will not be resolved when inside an inline code span or a fenced code block
+### Fixes
+- Fix issue with preview checkbox not updating markdown
+- Fix issue with backslash causing in certain markdown blocks
+## Pods
+### Support note references when Publishing Notes ([[docs|dendron.topic.publishing]])
+Dendron has [[note references|dendron.topic.refs]] that let you inline either the whole note or parts of a note into another note. Publishing via Dendron will also publish note references as part of the process.
+<a href="https://www.loom.com/share/8eb01f6c3196415c8aadc4992805a176"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/8eb01f6c3196415c8aadc4992805a176-with-play.gif"> </a>
+### Add Export Pod Command ([[docs|dendron.topic.commands]])
+Export notes to an external data source. Currently, only JSON is supported.
+<a href="https://www.loom.com/share/d49e5f4155af485cadc9cd810b6cab28"> <img src="https://cdn.loom.com/sessions/thumbnails/d49e5f4155af485cadc9cd810b6cab28-with-play.gif"> </a>
+### JSON export pod ([[docs|dendron.topic.pod]])
+Export your Dendron notes to a JSON file
+### Enhancements
+- Don't convert note refs inside code blocks
+## Publishing
+### Nav Based Hierarchy Hints ([[docs|dendron.topic.publishing]])
+You can see at a glance which notes have children and explore them from the nav without refreshing the page.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dendron.jekyll.gif)
+### Edit on Github ([[docs|dendron.topic.publishing]])
+Every page can accept one-click contributions as long as the contributor has a GitHub account.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/jekyll.edit.jpg)
+Example of making a contribution to Dendron.
+<a href="https://www.loom.com/share/4a1b67f3fd1a40dab16949e9ea5e53dc"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/4a1b67f3fd1a40dab16949e9ea5e53dc-with-play.gif"> </a>
+## Workbench
+### Add Goto Next/Prev Sibling command ([[docs|dendron.topic.commands]])
+- shortcuts:
+- mac: `cmd+shift+right`
+- key: `ctrl+shift+right`
+- when: `editorFocus`
+Go to the next/previous sibling
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-sibling.gif)
+### Add Go Down command ([[docs|dendron.topic.commands]])
+- shortcuts:
+- mac: `cmd+shift+down`
+- key: `ctrl+shift+down`
+- when: `editorFocus`
+Go down the hierarchy
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-down.gif)
+### Enhancements
+- Don't focus on the tree view if it's not visible
+- Create stub notes from the tree view
+### Fixes
+- Don't update color theme on upgrade
+- Upgrade settings sometimes override existing settings
+- Issues with note refs not displaying in some cases
+- Rename note will not update dendron tree view
+## Thank You
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release.
+- [Fayçal](https://github.com/d3vr)
+  - [Stylyzed Tag CSS](https://www.dendron.so/notes/692fa114-f798-467f-a0b9-3cccc327aa6f.html#stylized-tags-using-custom-css)
+  - [Dendron Tag Search Extension](https://marketplace.visualstudio.com/items?itemName=d3vr.tag-search)
+- [Ed](https://github.com/ens100)
+  - [Update Dendron docs](https://github.com/dendronhq/dendron-template/commit/28c86d5afba0f7ca21e15e749e67464cce2397e2)
+  - [Making an absolutely awesome getting started with Dendron video](https://www.youtube.com/watch?v=BRLLZ9IEh10)
+  - Writing up a step by step publishing guide for Dendron
+- [Daria Vasyukova](https://github.com/gereleth)
+  - Being a professional Dendron bug catcher
+    - <https://github.com/dendronhq/dendron/issues/162>
+    - <https://github.com/dendronhq/dendron/issues/161>
+    - <https://github.com/dendronhq/dendron/issues/143>
+- [mebu83](https://github.com/mebu83)
+  - [Issue with blof refs not resolving](https://github.com/dendronhq/dendron/issues/146)
+- [eflinfoki](https://github.com/eflinfoki)
+  - [Update dendron troubleshooting guide](https://github.com/dendronhq/dendron-template/pull/6)
+- [Janne Ojanaho](https://github.com/jojanaho)
+  - [Updating Dendron FAQ](https://github.com/dendronhq/dendron-template/commit/9252d12f21dc21fca0a2e2bf36da9edc84202227)
+- Tom
+  - [Providing a transcript of Dendron's onboarding video](https://www.dendron.so/#onboarding)
+- [Rhaynes](https://github.com/rhaynes74)
+  - [Issue with markdown preview not rendering math elements correctly](https://github.com/dendronhq/dendron/issues/156)
+- [Howard](https://github.com/runlevelrobot)
+  - [Issue with tree view making sidebar visible when not wanted](https://github.com/dendronhq/dendron/issues/150)

Added: vault/dendron.release.2020-09-13.md

Files changed (1) hide show

vault/dendron.release.2020-09-13.md +145 -0

vault/dendron.release.2020-09-13.md ADDED Viewed

@@ -0,0 +1,145 @@
+---
+id: 50071eda-fc46-4aca-ba6c-9d53db00d068
+title: Release Notes(version 0.11)
+desc: ''
+updated: 1610062114528
+created: 1596374871110
+date: '2020-09-13'
+---
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/comic.1.png)
+- My wife, Ilana Lin, drew a comic for this week's release. Follow her on [instagram](https://www.instagram.com/accidentalflower/) and she might draw more comics for Dendron 😇
+## Summary
+This week's release comes with improved references as well as better tooling around pods and snippets.
+**Dendron's pretty refs** help you identify when content is embedded from elsewhere and provide links back to the source.
+((ref:[[dendron.topic.refs]]# references,1:# *))
+The **Dendron CLI** lets you access a subset of Dendron's functionality inside the terminal, including the ability to import/export your notes.
+We also released the **Dendron Snippet Maker**, a standalone extension that comes bundled with Dendron which helps you create [[snippets|dendron.topic.snippets]] from the current selected text.
+These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
+## CLI
+### Release Dendron CLI
+Dendron now has a its own CLI that you can run standalone from the Dendron plugin.
+((ref:[[dendron.topic.cli]]#install))
+### Enhancements
+- Run export pod using cli
+- Run import pod using cli
+- Run backfill using cli
+### Fixes
+- Import using cli not initialized in certain cases
+## Notes
+### New note from selection cmd
+Create new note from a selection
+## Pods
+### Add configure pod command
+((ref:[[dendron.topic.commands]]#configure pod,1:#*))
+### Enhancements
+- Use consistent interface for import/export
+- Additional additional options on export
+### Fixes
+- Deal with `.` when importing directories
+## Publishing
+### Published sites use pretty refs
+((ref:[[dendron.topic.publishing.configuration]]#useprettyrefs,1:#*))
+### Support noindex option
+((ref:[[dendron.topic.publishing.configuration]]#noindex,1:#*))
+### Enhancements
+- Add config to specify pretty refs
+### Fixes
+- Update bad links
+- Fix ref display on published site
+## Refs
+### Support wildcard refs
+((ref:[[dendron.topic.refs]]#wildcard header reference,1:#*))
+### Enhancements
+- Create ref with anchor if selected
+- Render refs in container
+### Fixes
+- Bad ref resolution
+## Workbench
+### Dendron Snippet Maker
+((ref:[[dendron.pro.dendron-snippet-maker]]#dendron snippet maker,1))
+### Enhancements
+- Friendlier default settings
+## Community Announcements
+### Planters
+A bunch of our fellow Dendronites have published notes using Dendron. You can check it at the [[showcase|dendron.community.showcase]].
+We've also created a new role -> @Planter :man_farmer::woman_farmer: , to recognize folks who have published using Dendron.
+If you have a site you would like to showcase, please ping Kevin ([kevin@dendron.so](mailto:kevin@dendron.so)) or edit the showcase page directly and adding your site :)
+## Thank You
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release.
+- [Fayçal](https://github.com/d3vr)
+  - giving us the dendron emoji
+- [Ed](https://github.com/ens100)
+  - updating various Dendron docs
+  - raise copy issue when publishing a dendron vault
+  - contribute new default completion settings for Dendron
+- [Daria Vasyukova](https://github.com/gereleth)
+  - updating docs
+- [Handuo](https://github.com/zhanghanduo)
+  - suggest [better block refs](https://github.com/dendronhq/dendron/issues/174)
+  - suggest block refs autocomplete
+- [Mr. Lightbulb](https://github.com/JackQAQ-byte)
+  - [latex doesn't render when publishing](https://github.com/dendronhq/dendron/issues/195)
+- [Tom](https://github.com/peanutputter)
+  - [Image Markdown fails with spaces and caps in name of file](https://github.com/dendronhq/dendron/issues/200)

Added: vault/dendron.release.2020-09-20.md

Files changed (1) hide show

vault/dendron.release.2020-09-20.md +125 -0

vault/dendron.release.2020-09-20.md ADDED Viewed

@@ -0,0 +1,125 @@
+---
+id: 8e59e25f-808c-42f1-a82a-e9ce4fd8edd8
+title: Release Notes(version 0.12)
+desc: ''
+updated: 1609990694687
+created: 1596374871110
+date: 2020-09-20
+---
+Dendron 0.12 is here 🌱
+This week's focus was on publishing. We have a bunch of enhancements and additions to the publishing workflows. We also introduced the [[seeds library|dendron.topic.seeds]], a way of you to remix existing content with Dendron. You can see an example of this [here](http://aws.dendron.so/)
+This release also brings some changes to Dendron's update cycle.
+You might have noticed that Dendron updates rather aggressively 🚀🚀🚀
+Our current release cycle is a patch update every day and a minor release every week.
+Moving forward, we will be doing patch updates every few days and a minor release every two weeks.
+The move to this new release cycle is a reflection that Dendron is growing rapidly and starting to mature.
+We will be working on some major changes in October to stabilize the core feature set and make them easier to use. We will also be shifting our underlying architecture from a VSCode plugin to the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) which will result in a richer feature set and the ability for Dendron to be more easily integrated into additional editors.
+As part of this update, we've put out the first version of the [Dendron principles](https://dendron.so//notes/7fcebd7d-6411-4c9d-8baf-65629dc018a1.html) which reflects our design philosophies and the direction we are taking Dendron.
+This is a work in progress so feel free to make suggestions and comments in the discord.
+I've mentioned this before but we will also be releasing our formal roadmap by the end of the month. This roadmap will cover all major projects we plan on doing in 2020.
+We are looking to come out of preview by the end of October and do a formal 1.0 release before the end of the year.
+I want to take this moment to again thank everyone for being part of our journey to build a better tool for managing knowledge 👨‍🌾👩‍🌾
+I believe we're are planting something special here and am excited to see us grow 🌱
+These release notes are summary of the more notable changes, for the full list, please look at our [CHANGELOG](https://github.com/dendronhq/dendron/blob/master/CHANGELOG.md)
+* * *
+## Cli
+### Support for seeds
+((ref:[[dendron.topic.seeds]]#seeds 🚧,1:#*))
+### Enhancements
+- Standardize on core cli flags across all commands
+- More options when planting seeds
+## Hierarchies
+### Fixes
+- Rename when stub is present
+## Lookup
+### Lookup new notes with Selection
+((ref:[[dendron.topic.lookup]]#creating notes with a selection,1:#*))
+### Enhancements
+- Lookup can extract highlighted text
+## Pods
+### Implement Json import pod
+((ref:[[dendron.topic.pod.builtin.json]]))
+### Enhancements
+- All filepaths can be set relative to the workspace root
+- Json pod can import filenames as links
+- Standardize interface for import/export pod commands
+### Fixes
+- Handle stub notes correctly on import
+## Publishing
+### Publish command
+((ref:[[dendron.topic.commands]]#publish,1:#*))
+### Copy note url command
+((ref:[[dendron.topic.commands]]#copy note url,1:#*))
+### Enhancements
+- Support relative path for all file paths
+- Set custom path for publishing repo
+- Keyboard shortcuts for copy note url cmd
+- Be able to pass in custom args to commands
+- Support incremental page building
+### Fixes
+- Copy url truncates `//`
+## Thank You
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release.
+- [Denis Sikuler](https://github.com/gamtiq)
+  - update docs
+- [agichim](https://github.com/agichim)
+  - update docs
+- [Daria Vasyukova](https://github.com/gereleth)
+  - bug with copy note url
+- [Jack](https://github.com/JackQAQ-byte)
+  - issue with images on published sites
+- [Tom](https://github.com/peanutputter)
+  - [issue with image paths](https://github.com/dendronhq/dendron/issues/200)
+- [Janne Ojanaho](https://github.com/jojanaho)
+  - [writeup on files vs folders](https://github.com/dendronhq/dendron/issues/210)

Added: vault/dendron.release.2020-10-19.md

Files changed (1) hide show

vault/dendron.release.2020-10-19.md +67 -0

vault/dendron.release.2020-10-19.md ADDED Viewed

@@ -0,0 +1,67 @@
+---
+id: 1b1aef8e-c9d5-42de-b850-d1b1467cf88b
+title: Release Notes(version 0.13)
+desc: ''
+updated: 1609990585321
+created: 1603123991664
+---
+Dendron 0.13 is here 🌱
+It's been a few weeks since the last minor release. This iteration was mostly spent on our server migration as well as a series of quality of life improvements across Dendron's core features. You can find the details of all this in the highlights below.
+## Highlights
+- move to the final phase of the [[server migration|dendron.roadmap.project.n.2020.server-migration]]
+  - Dendron server mode is now at feature parity with existing functionality
+  - the server migration is a complete re-write of Dendron's internal to go from a client to client (local) server model
+  - this is pre-requisite for a bunch of upcoming features like [[multi vault support|dendron.roadmap.project.n.2020.multi-vault]], rich graphical interfaces, and realtime graph updates
+  - server mode will be the default for all workspaces going forward
+  - existing workspaces will be transparently migrated over after next week
+- order of magnitude speed improvements (server mode only)
+  - initializing large vaults
+  - updating links through `Rename` and `Refactor` operations
+- better note references
+  - note references can now be nested
+  - a reference to a header can be made by selecting any part of the header before running `Copy Note Ref`
+- better timestamps (server mode only)
+  - the `updated` timestamp on notes now updates on every save
+  - timestamp will now print a human friendly label
+- improved publishing
+  - dendron sites now support latex
+  - dendron will generate a bad link report for all links that do not resolve when publishing
+  - bad links will now resolve to a custom 404 link
+  - you can define a custom site repository that will be used by publishing commands
+- consolidated lookup
+  - creating journal notes and scratch notes are now part of the `Lookup Command` instead of being separate commands (the old keyboard shortcuts still work - they now map to lookup commands with custom arguments)
+  - lookup now accepts arguments that can be passed in via custom keyboard shortcuts
+  - you can control the creation of special notes as well as note selection behavior from lookup
+## Seeds
+Aside from features, we've also launched two [[seeds|dendron.topic.seeds]]. Seeds are **open source dendron sites** that **consolidate reference material** about a **particular vertical**. Content from the catalogues is derived from existing open source content as well as manual user input. Your 🙏 is welcomed and encouraged.
+((ref:[[dendron.community.showcase]]#open pkm catalogue,1:#*))
+((ref:[[dendron.community.showcase]]#open aws catalogue,1:#*))
+## Sustainability
+Finally, a bunch of you have asked if you can support Dendron financially. The answer is coming at the end of the month! Dendron will be coming out of **preview** in November, at which point we will launch our **Environmentalist Plan** 🌲. This is a monthly subscription to support the development of Dendron. **Environmentalist** will get a special badge on Discord, priority email/discord access to the development team, and stickers! More details on this soon.
+## Thank You
+Last and most of all, a big to the following gardeners that brought up issues, contributions, and fixes to this release.
+- [Britt](https://github.com/bs)
+  - [silent log errors](https://github.com/dendronhq/dendron/issues/277)
+  - various doc updates
+- [onwijsbegeerte](https://github.com/onwijsbegeerte)
+  - [bad export pod placeholder text](https://github.com/dendronhq/dendron/issues/270)
+- [agichim ](https://github.com/agichim)
+  - [checkbox in preview doesn't render correctly](https://github.com/dendronhq/dendron/issues/269)
+- [Emaro](https://github.com/Emaro)
+  - [treeview empty in certain cases](https://github.com/dendronhq/dendron/issues/263)
+- [robothor](https://github.com/robothor)
+  - [issue refactoring with mixed case filenames](https://github.com/dendronhq/dendron/issues/250)
+((ref:[[dendron.release.changelog]]#0.12.11,1))

Added: vault/dendron.release.2020-11-01.md

Files changed (1) hide show

vault/dendron.release.2020-11-01.md +80 -0

vault/dendron.release.2020-11-01.md ADDED Viewed

@@ -0,0 +1,80 @@
+---
+id: 98ad9b6b-53f3-4883-939e-e14055f2cac7
+title: Release Notes(version 0.14)
+desc: ''
+updated: 1609990585322
+created: 1604241475533
+---
+Dendron 0.14 is here 🌱
+At 14, Dendron might not yet be old enough to vote (if you are old enough and in the USA, please do that next week) but it is coming out of **preview** 🥳
+Concretely, this means a few things:
+1. Dendron is announcing our **[Environmentalist](https://accounts.dendron.so/account/subscribe)** plan, a 100% optional monthly subscription for users who like to support us financially
+2. Dendron will now commit to a regular release cycle. New releases will go out at the beginning of every week. **Environmentalist** will get access to early builds and features every few days.
+3. Dendron will have a deprecation policy for all non-experimental (🚧) features. Any potentially breaking changes will first be deprecated and users will have at least a week's notice before a breaking change is made.
+4. Dendron is dropping the preview label
+   ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/preview.png)
+As part of getting out of preview, we are launching on [Product Hunt](https://www.producthunt.com/posts/dendron), a popular online catalogue for new products. If Dendron has been helpful in your life, we would appreciate it 🙏 if you could leave us some comments there. This will help new people discover our community!
+<a href="https://www.producthunt.com/posts/dendron?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-dendron" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=273037&theme=light" alt="Dendron - A better way to know | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
+### Highlights
+- complete [[server migration|dendron.roadmap.project.n.2020.server-migration]] for all users
+- create [[snapshots|dendron.topic.capabilities.snapshot]] of your vault and restore them back to a specific point in time
+- introduce [Environmentalist Plans](https://accounts.dendron.so/account/subscribe) for folks that want to support Dendron financially
+- add [publishing](https://dendron.so/notes/66727a39-d0a7-449b-a10d-f6c438185d7f.html#publish) capability to pods (with ability to publish to json and regular markdown)
+- support creating generated [table of contents](https://dendron.so/notes/ffa6a4ba-5eda-48c7-add5-8e2333ba27b4.html#toc) when publishing
+- realtime schema validation when saving
+- numerous enhancements
+- numerous bug fixes
+- better handling of errors and failures
+### Community
+- new roles
+  - introduce the **Environmentalist** role, created for folks that are keeping Dendron sustainable through a monthly contribution
+    - Britt Selvitelle (@britt#3020)
+    - Tom Diaz (@TomD#7339)
+    - Kiran Pathakota (@kpats#8761)
+    - Cristian Caratti (@ccaratti#2465)
+    - Ken Sonoda (@ksoda#9504)
+    - Adam Howard (@A Howard#8010)
+    - Ladd Hoffmab (@Bassmann#5300)
+    - Fayçal MITIDJI (@bsqrd#9701)
+    - Tyler Nieman (@tsnieman#6157)
+    - Ilana Lin (@ilana#7242)
+    - Luke Roslanowski (@lukecarrier#2081)
+    - Huw Millar
+    - Martin Stemplinger
+  - introducing the **Horticulturalist** role, created for folks who have contributed to the Dendron code base
+    - Britt Selvitelle (@britt#3020)
+    - Luke Roslanowski (@lukecarrier#2081)
+- we now have a new [[community|dendron.community]] section on our website that highlights the work and roles of our members
+### House Keeping
+- `dendron.noServerMode` setting has been removed
+- Dendron docs has been re-organized to be less overwhelming (if you have an links bookmarked, they will still all work because of Dendron's [permanent links](https://dendron.so/notes/5fcb8564-7209-4a80-9bb8-025bc8eb489b.html#permanent-ids))
+### Upcoming
+- Dendron office hours: this will be additional slots you can book outside of the initial onboarding to go over specific workflows. More details and schedule to follow in next week's release!
+- Dendron [[Multi Vault Support|dendron.roadmap.project.n.2020.multi-vault]]
+- Better migration workflows from other tools into Dendron
+### Thanks
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release.
+- [Britt](https://github.com/bs)
+### Changelog
+((ref:[[dendron.release.changelog]]#13.6:#0.12.11))

Added: vault/dendron.release.2020-11-08.md

Files changed (1) hide show

vault/dendron.release.2020-11-08.md +49 -0

vault/dendron.release.2020-11-08.md ADDED Viewed

@@ -0,0 +1,49 @@
+---
+id: 63ea2e72-4eba-406c-9f4c-7300fa0b8935
+title: Release Notes(version 0.15)
+desc: ''
+updated: 1609990585327
+created: 1604882865662
+---
+Dendron 0.15 is here 🌱
+### Highlights
+- [lookup multi-select](https://dendron.so/notes/ad270a7d-2aed-4273-8319-eb6536e38b29.html#multiselect)
+- [copy links](https://dendron.so/notes/ad270a7d-2aed-4273-8319-eb6536e38b29.html#copywikilink) from lookup
+- better [obsidian markdown import](https://dendron.so/notes/13c4a608-0a32-4c62-9c7e-2b7f9f2d18bf.html#links)
+- multiple bug fixes
+- better code hygiene after removing ~8000 lines of code
+### Community
+I'm thrilled to announce our latest **Dendrologist**! Meet Luke (@lukecarrier#2081) 👨‍🌾
+> Hey 👋 I’m Luke and I’m going to be picking up some development work. Ask me about the markdown editing experience, publishing and integrating external tools.
+((ref:[[dendron.community.roles]]#dendrologist,1:#*))
+### In the Works
+- Still working through the details of official Dendron office hours. Expect a message later this week!
+- Dendron [[Multi Vault Support|dendron.roadmap.project.n.2020.multi-vault]]
+- [November Milestones](https://github.com/dendronhq/dendron/milestone/5)
+### Thanks
+- environmentalist 👨‍🌾👩‍🌾
+  - Michael Pfammatter
+  - Matthew Long
+  - Geert Theys
+  - Huw Millar
+- [gnomesoup](https://github.com/gnomesoup)
+  - [bad create daily journal note signature](https://github.com/dendronhq/dendron/issues/333)
+- [seedublancaster](https://github.com/seedublancaster)
+  - [fix typos](https://github.com/dendronhq/dendron/pull/323)
+- [tfer](https://github.com/tfer)
+  - [update docs on stub](https://github.com/dendronhq/dendron-template/pull/33/files)
+## Changelog
+((ref:[[dendron.release.changelog]]#changelog,1:#13.6))

Added: vault/dendron.release.2020-11-15.md

Files changed (1) hide show

vault/dendron.release.2020-11-15.md +56 -0

vault/dendron.release.2020-11-15.md ADDED Viewed

@@ -0,0 +1,56 @@
+---
+id: 11c9f170-3864-4406-9631-053241553b35
+title: Release Notes(version 0.16)
+desc: ''
+updated: 1610062031478
+created: 1605459905174
+---
+Dendron 0.16 has sprouted 🌱
+### Highlights
+- even faster lookup 🚀 🚀 🚀
+  - we made a bunch of optimizations to lookup so it is now many times faster
+- wildcard note ref links
+  - you can now add a `*` operator to the end of your note references to grab everything from a level of hierarchy
+- experimental multi-vault support 🚧
+  - you can now add any number of vaults to your workspace and query everything using lookup
+- a slimmed down getting started experience
+  - instead of 100+ notes, you now get 1 note (with links to 100+ notes)
+- lots of bug fixes 🔨🐛
+### Community
+- Dendron Office Hours
+  - We are kicking off our live bi-monthly office hours this week! The first session will be held this Wednesday (11/18) at 12PM PST on [Twitch](https://www.twitch.tv/dendronhq)
+  - Office hours are a channel to get answers to all the questions you're not afraid to ask during a live stream
+  - For people that can't make the time, we will have the session recorded and are taking questions ahead of time in the #office-hours channel on discord
+  - link to the original [discord announcement](https://discord.com/channels/717965437182410783/737323300967022732/776567468356927568)
+### In the Works
+- a better **up to date** public roadmap
+- bringing multi-vault to feature parity with all existing Dendron functionality
+- a better publishing experience
+### Thanks
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
+- [Luke Carrier](https://github.com/LukeCarrier)
+  - [New getting started experience](https://github.com/dendronhq/dendron-template/pull/1)
+- [Chris Pickett](https://github.com/bunchesofdonald)
+  - [fix typos in initial vault notes](https://github.com/dendronhq/dendron/pull/335)
+- [Jan Reitz](https://github.com/janreitz)
+  - [fix yml block in docs](https://github.com/dendronhq/dendron-template/pull/36)
+- [Konrad Jamrozik](https://github.com/konrad-jamrozik)
+  - [bad schema in initial vault notes](https://github.com/dendronhq/dendron/issues/342)
+- [Danny Tran](https://github.com/nabdtran)
+  - [fix typos in docs](https://github.com/dendronhq/dendron-site/pull/37)
+- [Bassmann](https://github.com/Bassmann), [Konrad Jamrozik](https://github.com/konrad-jamrozik)
+  - [can't create scratch notes issue](https://github.com/dendronhq/dendron/issues/346)
+### Changelog
+((ref:[[dendron.release.changelog]]#0.15.3:#0.14.2))

Added: vault/dendron.release.2020-11-22.md

Files changed (1) hide show

vault/dendron.release.2020-11-22.md +70 -0

vault/dendron.release.2020-11-22.md ADDED Viewed

@@ -0,0 +1,70 @@
+---
+id: f09162ec-6b20-4b53-bd5c-68aaa4698ed8
+title: Release Notes(version 0.17)
+desc: ''
+updated: 1609990585314
+created: 1606074212157
+---
+Dendron 0.17 has sprouted 🌱
+### Highlights
+- better autocomplete for wiki links
+  - autocomplete will now prompt without a trigger, complete on links with aliases and complete faster than ever
+- relative wiki links
+  - you can now link to a specific section of a note using the `[[foo#header]]` syntax
+- faster language features  🚀 🚀 🚀
+  - going to a link definition, finding link references and other link specific functionality is much faster
+- lots of bug fixes and enhancements
+  - bunch of things are better with this release
+### Community
+- Dendron Office Hours
+  - We had our first live office hours this week. Thanks to everyone that participated! You can find the recording [here](https://discord.com/channels/717965437182410783/737323300967022732/778798279658962944). A reminder that you can submit questions ahead of time in the #office-hours channel in [discord](https://discord.gg/AE3NRw9). We'll send another survey this week for scheduling the next office hours at the end of the month.
+### House Cleaning
+- Deprecation of `Dendron Markdown Notes`
+  - prior to 0.17, Dendron used the aforementioned extension for language features like auto completion and following links
+  - with 0.17, all language features is now being handled with Dendron
+  - Dendron Markdown Notes is no longer required and can interfere with new definitions
+  - You can uninstall Dendron Markdown Notes through the extensions panel inside VSCode
+      ![uninstall ](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/etc.install.jpg)
+- Version Number in DendronConfig
+  - `dendron.yml` now has an added `version` field. It's automatically set to `0` for all current configurations. we'll be coming out with a new version in the near future to support additional multi-vault features
+### In the Works
+Most of the same items from last week still apply 😅
+- a better **up to date** public roadmap
+- bringing multi-vault to feature parity with all existing Dendron functionality
+- a better publishing experience
+### Thanks
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
+- [Konrad Jamrozik](https://github.com/konrad-jamrozik)
+  - [fix typo](https://github.com/dendronhq/dendron-site/pull/38)
+  - [show note graph doesn't prune stubs](https://github.com/dendronhq/dendron/issues/359)
+- [Daniel Zhang](https://github.com/DanielHZhang)
+  - [rename note issues](https://github.com/dendronhq/dendron/issues/338)
+- [Tyler Nieman](https://github.com/tsnieman)
+  - [Dendron graph title](https://github.com/dendronhq/dendron/issues/358)
+- [LucasD3](https://github.com/LucasD3)
+  - [missing welcome note](https://github.com/dendronhq/dendron/issues/361)
+- [Gabriel Horner](https://github.com/cldwalker)
+  - [update multi-vault docs](https://github.com/dendronhq/dendron-site/pull/39)
+- [Oli Crask](https://github.com/OxygenLithium)
+  - [Stale notes in tree view](https://github.com/dendronhq/dendron/issues/367)
+- [John Young](https://github.com/iterating)
+  - [Don't override minimap preferences](https://github.com/dendronhq/dendron/issues/366)
+- [Tim Condit](https://github.com/tcondit)
+  - [Fix typos](https://github.com/dendronhq/dendron-site/pull/40)
+### Changelog
+((ref:[[dendron.release.changelog]]#0.16.3:#0.16.1))

Added: vault/dendron.release.2020-11-29.md

Files changed (1) hide show

vault/dendron.release.2020-11-29.md +52 -0

vault/dendron.release.2020-11-29.md ADDED Viewed

@@ -0,0 +1,52 @@
+---
+id: a929ff5a-b6c0-417b-a3af-d70af3626aa5
+title: Release Notes (version 0.18)
+desc: ''
+updated: 1609261174120
+created: 1606679635868
+---
+Dendron 0.18 has sprouted 🌱
+### Highlights
+- instant link previews
+  - peek into links without opening them
+- dendron web ui (for configuration updates)
+  - configure dendron using shiny new graphics
+- more multi-vault enhancements
+  - support more commands
+- lots of bug fixes
+  - because bugs are not a feature
+### Community
+- Dendron Office Hours
+  - Our next live office hours will take place this Wednesday (12/02) at 11AM PST on [twitch](https://www.twitch.tv/dendronhq). A reminder that you can submit questions ahead of time in the #office-hours channel in [discord](https://discord.gg/AE3NRw9). We'll send another survey this week for scheduling the next office hours at the end of the month.
+### In the Works
+- bringing multi-vault to feature parity
+- better note references
+- a better publishing experience
+### Thanks
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
+- [Gabriel Horner](https://github.com/cldwalker)
+  - [fix out of date jekyll config](https://github.com/dendronhq/dendron/pull/372)
+- [Kiran Pathakoda](https://github.com/kpathakota)
+  - [fix build issues](https://github.com/dendronhq/dendron/pull/379)
+- [Ilia Auerbach-Ziogas](https://github.com/iliaaz)
+  - [fix typo](https://github.com/dendronhq/dendron-site/pull/43)
+- [ms3056](https://github.com/ms3056)
+  - [fix typo](https://github.com/dendronhq/dendron/issues/383)
+- [Christopher Corley](https://github.com/cscorley)
+  - [Toggle plugin views using 'when' contexts](https://github.com/dendronhq/dendron/pull/386)
+- [Tyler Nieman](https://github.com/tsnieman)
+  - [Dendron Web UI PR](https://github.com/dendronhq/dendron/pull/351)
+### Changelog
+((ref:[[dendron.release.changelog]]#0.17.2:#0.16.3))

Added: vault/dendron.release.2020-12-07.md

Files changed (1) hide show

vault/dendron.release.2020-12-07.md +53 -0

vault/dendron.release.2020-12-07.md ADDED Viewed

@@ -0,0 +1,53 @@
+---
+id: 42e90950-38c4-4869-9f3c-ddd84f7ac7eb
+title: Release Notes(version 0.19)
+desc: ''
+updated: 1609990585307
+created: 1607367621793
+---
+Dendron 0.19 is here 🌱
+### Highlights
+- support for remote vaults
+  - natively add vaults published to git to your current workspace
+- support for image hover
+  - peek at images without using the preview
+- most commands are now multi-vault enabled
+  - yay multi-vault
+- much faster lookup performance for large vaults
+- lots of bug fixes
+### Community
+- @ianjones#3696 and @karlicoss#6608 became the latest `@Planters` to publish using Dendron: <https://dendron.so/notes/3a82c5ff-7945-46ae-8bf9-3b2275fc6642.html>
+- we added 2 new `@Environmentalist`: thank you @fudo#1010 and @mcbishop#3274 for contributing!
+  - fun fact: we now have environmentalists in every continent except Antartica 👨‍🌾 👩‍🌾
+- @ianjones#3696 made an awesome series of videos that go over getting started with Dendron: <https://egghead.io/playlists/build-a-personal-knowledge-management-system-with-dendron-b24b>
+### In the Works
+- finish multi-vault feature parity
+  - list of non-compatible commands can be found [[here|dendron.topic.multi-vault#known-issues]] (we're almost done)!
+- a better publishing experience
+- better note references
+### Thanks
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
+- [Bassmann](https://github.com/Bassmann)
+  - [can't add local vault](https://github.com/dendronhq/dendron/issues/396)
+  - [issue creating journal notes in multi-vault](https://github.com/dendronhq/dendron/issues/395)
+- [Franco Barbeite](https://github.com/FrancoB411)
+  - [markdown import breaks latex](https://github.com/dendronhq/dendron/issues/389)
+- Kevin
+  - errors when running doctor command
+- Mike
+  - completion not matching the whole link
+  - tree view putting notes under wrong vault
+### Changelog
+((ref:[[dendron.release.changelog]]#0.18.2:#0.17.2))

Added: vault/dendron.release.2020-12-14.md

Files changed (1) hide show

vault/dendron.release.2020-12-14.md +59 -0

vault/dendron.release.2020-12-14.md ADDED Viewed

@@ -0,0 +1,59 @@
+---
+id: 44fd6c57-b7f4-47f5-a632-d352d4f4fa7b
+title: Release Notes(version 0.20)
+desc: ''
+updated: 1609990585324
+created: 1607890901199
+---
+Dendron 0.20 is here 🌱
+### Highlights
+- dendron seed bank
+  - a registry of open source vaults that you can add to your workspace
+- refactor for multi-vault
+  - one of the last items for multi-vault feature parity is now here
+- select vault on creation
+  - option to always pick which vault new notes are created in
+- many enhancements and bugfixes
+### Community
+- @ianjones#3696 and @fudo#1010 boosted the Dendron Server which means we have lots more custom emoji slots we need to fill. Any suggestions welcome :)
+- new planters: @dolearning (Kevin)#3551
+- new bug catchers: @Costa#1636, @niveus#4940, @Buxel#7181
+- new horticulturalist: @dolearning (Kevin)#3551, @ianjones#3696, @bublucious#1002
+- new taxonomist: @dolearning (Kevin)#3551, @fudo#1010
+You can find a description of all roles [[here|dendron.community.roles]]
+### In the Works
+- finish multi-vault feature parity
+  - we're down to our last few features
+  - list of non-compatible commands can be found [[here|dendron.topic.multi-vault#known-issues]] (we're really almost done)
+- a better publishing experience
+- better note references
+### Thanks
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
+- Costa
+  - issue with image preview links
+- [Kevin Cunningham](https://github.com/doingandlearning)
+  - [add search to 11ty template](https://github.com/dendronhq/dendron-11ty/pull/5)
+- [Chris Na](https://github.com/buxel)
+  - [issue with Dendron Doctor](https://github.com/dendronhq/dendron/issues/400)
+- Brian Scott
+  - issue with nested git repos
+  - remote repo doesn't respect name settings
+- [Josh Brainard](https://github.com/brainjos)
+  - [note creation not respect title case](https://github.com/dendronhq/dendron/pull/404)
+- [flammehawk](https://github.com/flammehawk)
+  - bad link in testimonial docs
+### Changelog
+((ref:[[dendron.release.changelog]]#0.19.3:#0.18.2))

Added: vault/dendron.release.2020-12-21.md

Files changed (1) hide show

vault/dendron.release.2020-12-21.md +51 -0

vault/dendron.release.2020-12-21.md ADDED Viewed

@@ -0,0 +1,51 @@
+---
+id: e543ad13-1108-448c-b3a6-9976fd7a65ce
+title: Release Notes(version 0.21)
+desc: ''
+updated: 1609990585326
+created: 1608580995965
+---
+Dendron 0.21 is here 🌱
+With 0.21, multi-vault should now be at feature parity with single vault workspaces. Multi-vault specific behavior is documented [[here|dendron.topic.multi-vault]].
+0.21 also brings about Dendron's 2nd Generation publishing feature. This is a faster, leaner, and more powerful way to publish your notes using Dendron.
+There's still some work left to integrate publishing into the Dendron plugin - meanwhile, you can take the new publishing workflow for a spin by following the instructions [[here|dendron.topic.publishing.quickstart]]
+### Highlights
+- publishing v2
+  - v2 is over 30x faster (compiling the dendron site takes 6s for 200 pages vs 220s in v1) 🚀🚀🚀
+  - v2 supports publishing with multi-vault
+  - v2 is all javascript (no more download ruby just to publish)
+- support note references for multi-vault
+- bug fixes and performance improvements
+### Community
+- new bug catchers: @rasmuse#4440 @Contessa#0861 @TokyoMike#2771
+- new environmentalist: @Stephen#8544
+You can find a description of all roles [[here|dendron.community.roles]]
+### In the Works
+- bring publishing v2 to feature parity
+- better note references
+### Thanks
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
+- [Rasmus Einarsson](https://github.com/rasmuse)
+  - [Self referential refactoring issue](https://github.com/dendronhq/dendron/issues/406)
+- [Whitney](https://github.com/whitbur)
+  - [Note creation from selected text mangles non-vault files](https://github.com/dendronhq/dendron/issues/410)
+- [Mike](https://github.com/ms3056)
+  - [Matching requires unique files for lower nodes](https://github.com/dendronhq/dendron/issues/407)
+### Changelog
+((ref:[[dendron.release.changelog]]#0.20.2:#0.19.3))

Added: vault/dendron.release.2020-12-28.md

Files changed (1) hide show

vault/dendron.release.2020-12-28.md +56 -0

vault/dendron.release.2020-12-28.md ADDED Viewed

@@ -0,0 +1,56 @@
+---
+id: e05c751f-7d5c-4fcf-8868-01092813d1dd
+title: Release Notes(version 0.22)
+desc: ''
+updated: 1609990585313
+created: 1609180024902
+---
+Dendron 0.22 is here 🌱
+This release focuses on Dendron's [[Publishing v2|dendron.topic.publishing]]. With this release, v2 is functionally at feature parity with our legacy jekyll based publishing (and over 30x faster). You can see the remaining gaps [[here|dendron.topic.publishing.migration#gaps]]. These should be closed by the end of this week.
+- NOTE: to get the latest publishing changes, make sure to run the following commands in your workspace. See [[here|dendron.topic.publishing.quickstart]] for setup instructions
+```
+npm install @dendronhq/dendron-cli@latest
+npm install @dendronhq/dendron-11ty@latest
+```
+### Highlights
+- dendron v2 publishing functionally at feature parity with legacy publishing
+  - we're using it to host [dendron.so](https://dendron.so/) now :)
+- [[github actions based publishing workflow|dendron.topic.publishing.github]]
+  - keep a clean git history by having github manage building your website
+- bug fixes and performance improvements
+### In the Works
+- Integrate publishing with plugin
+- Auto generate title based on frontmatter
+- More publishing and preview features
+### Thanks
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release 👨‍🌾 👩‍🌾
+- first timer (see [[roles here|dendron.community.roles]])
+  - bug catchers: @Metalsmf#7744 @Stephen#8544 @muon#1974 @Francobar#1299
+  - taxonomist: @eeBaiQuai#1157
+- all contributions
+  - Britt Richardson (@Metalsmf#7744)
+    - issue building site on diff versions of node
+    - [fix typo](https://github.com/dendronhq/dendron-site/pull/50)
+  - [flammehawk](https://github.com/flammehawk)
+    - [remove colors from dev env](https://github.com/dendronhq/dendron/pull/423)
+  - Stephen (@Stephen#8544)
+    - issue building 11ty on multiple operating systems
+  - Muon (@muon#1974) and [Franco Barbeite](https://github.com/FrancoB411):
+    - [issue with math in preview](https://app.zenhub.com/workspaces/dendron-5f06937cfa4f3b001d5673c9/issues/dendronhq/dendron/424)
+  - [Newman5](https://github.com/Newman5)
+    - [typo in faq](https://github.com/dendronhq/dendron/pull/426)
+### Changelog
+((ref:[[dendron.release.changelog]]#0.21.2:#0.20.2))

Added: vault/dendron.release.2021-01-04.md

Files changed (1) hide show

vault/dendron.release.2021-01-04.md +62 -0

vault/dendron.release.2021-01-04.md ADDED Viewed

@@ -0,0 +1,62 @@
+---
+id: e81d2800-83c0-4ba6-8f00-34c3557da43d
+title: Release Notes (version 0.23)
+desc: ''
+updated: 1609787304398
+created: 1609786176221
+---
+Dendron 0.23.0 has sprouted :seedling:
+See the upgrade instructions [[here|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
+### Highlights
+- auto-title notes using note frontmatter
+  - titles show up in preview and when publishing
+- lots of publishing enhancements
+  - support blog like archives, much smaller bundle sizes, auto focused nav and more
+- cli based doctor
+  - make sure your notes are healthy for the new year
+### In the Works
+- integrating 11ty publishing with dendron workspace
+- managed publishing
+- better ergonomics around multi-workspace
+### Thanks
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
+- new role assignments:
+  - bug catchers: @Oli916#5867 @ric03uec#5826
+  - environmentalist: @corey#9677
+- all contributions
+  - [Bassmann](https://github.com/Bassmann) @Bassmann#5300
+    - doctor doesn't exit after running
+  - [Micharris42](https://github.com/micharris42)
+    - [Document Display Order in the Dendron Tree View](https://github.com/dendronhq/dendron/issues/440)
+  - [Oli Crask](https://github.com/olivercrask) @Oli916#5867
+    - [Published extended syntax markdown not rendering](https://github.com/dendronhq/dendron/issues/437)
+    - [Dendron publish not authenticating](https://github.com/dendronhq/dendron/issues/436)
+  - [Devashish](https://github.com/ric03uec) @ric03uec#5826
+    - [publish V2 throws error locally](https://github.com/dendronhq/dendron/issues/434)
+  - [Simon J S Liu](https://github.com/wind13) @Simon Liu#7080
+    - [Improve the import pod feature for import Hugo/Hexo etc](https://github.com/dendronhq/dendron/issues/432)
+  - [BC](https://github.com/generic-user)
+    - [Ctrl + hover creates a note, it should only create one on Ctrl + Click #430](https://github.com/dendronhq/dendron/issues/430)
+  - [Luke Carrier](https://github.com/LukeCarrier) @lukecarrier#2081
+    - tireless work battling windows CI issues
+### Version Numbers
+Version numbers for this week's release
+- plugin: 0.23.0
+- 11ty: v1.23.0
+- preview: 0.10.17
+### Changelog
+((ref:[[dendron.release.changelog]]#0.22.2:#0.21.2))

Added: vault/dendron.release.2021-01-11.md

Files changed (1) hide show

vault/dendron.release.2021-01-11.md +48 -0

vault/dendron.release.2021-01-11.md ADDED Viewed

@@ -0,0 +1,48 @@
+---
+id: d508e0f9-8bbe-43b4-83c1-0ff022b1d4fb
+title: Release Notes (version 0.24)
+desc: ''
+updated: 1610992516921
+created: 1610403349466
+---
+Dendron 0.24 has sprouted :seedling:
+### Highlights
+- updated note ref syntax ([[docs|dendron.topic.refs]])
+  - use `![[foo]]` to create a note ref
+- frontmatter variable substitution ([[docs|dendron.topic.markdown#frontmatter-variable-substitution]])
+  - use variables defined in your frontmatter inside your notes!
+- markdown improvements for preview and publishing ([[docs|dendron.topic.markdown#extended-syntax]])
+- bugs and performance related changes
+### Breaking Changes
+- update date format for journal and scratch notes to use [Luxon style formatting](https://moment.github.io/luxon/docs/manual/formatting.html) ([[docs|dendron.topic.config#dendrondefaultjournaldateformat]])
+  - this affects you if you updated `dendron.default*DateFormat` to something other than the default
+  - we made this change because [moment.js](https://momentjs.com/docs/#/-project-status/), our original date library, is now a legacy project and won't be receiving any new updates
+### Community
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
+- new role assignments
+  - grndstt: @grndstt#1420
+- all contributions
+  - grndstt: @grndstt#1420
+    - issue publishing with subdomain
+  - [Mike](https://github.com/ms3056) @TokyoMike#2771
+    - [links in preview not rendering correctly](https://github.com/dendronhq/dendron/issues/442)
+  - [Bassmann](https://github.com/Bassmann) @Bassmann#5300
+    - windows Dendron publishing QA work
+### Versions Numbers
+This release comes with the following versions:
+- dendron plugin: 0.24.0
+- dendron markdown preview: 0.10.19
+- dendron cli: 0.24.0
+- dendron 11ty: 1.24.0
+- dendron plugin and dendron markdown preview will be auto-installed by VSCode
+- See the upgrade instructions [[here for dendron-11ty and dendron cli|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
+![[dendron.release.changelog#0232:#0222]]

Added: vault/dendron.release.2021-01-18.md

Files changed (1) hide show

vault/dendron.release.2021-01-18.md +65 -0

vault/dendron.release.2021-01-18.md ADDED Viewed

@@ -0,0 +1,65 @@
+---
+id: 9293d889-e07f-4a01-b67f-e8aca7c1c7f7
+title: Release Notes (version 0.25)
+desc: ''
+updated: 1614965553884
+created: 1610992021546
+---
+Dendron 0.25 has sprouted 🌱
+### Highlights
+- native publication
+  - preview and build your notes for publication from within VSCode ([[docs|dendron.topic.commands#site-build]])
+- custom header support
+  - include your own headers when publishing ([[docs|dendron.topic.publishing.configuration#customheaderpath-optional]])
+- bunch of bug fixes and enhancements
+### Spring Cleaning
+- [[dendron v1|dendron.topic.publishing]] publishing is now being deprecated
+  - all users are encouraged to switch to [[Publishing V2|dendron.topic.publishing]]
+  - support until end of January at which point we will be removing v1 related functionality
+  - this includes
+    - [[Build Pod Command|dendron.topic.commands#build-pod]]
+    - [[Publish Command|dendron.topic.commands#publish]]
+    - [[buildSite CLI|dendron.topic.cli#buildsite]]
+    - [[publishnotes CLI|dendron.topic.cli#publishnotes]]
+- [[dendron.copyNoteUrlRoot|dendron.topic.config#dendroncopynoteurlroot]] deprecated for `siteUrl`
+### Community
+Last and most of all, a big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
+- [Luke Carrier](https://github.com/LukeCarrier) @lukecarrier#2081
+  - [CI/CD on push](https://github.com/dendronhq/dendron/pull/449)
+  - Ryan Randall `#environmentalist`
+    - contributing to dendron
+- [Mark H. Choi](https://github.com/hikchoi/cerebrarium) @hikchoi#8934 `#taxonomist` `#bug-catcher`
+  - [[Dendron QA Notes|dendron.dev.testing.notes]]
+  - [issue with breadcrumbs](https://github.com/dendronhq/dendron-11ty/issues/9)
+- [Simon Claudius](https://github.com/Simon-Claudius) @Simon-Claudius#7577 `#bug-catcher`
+  - [graph view broken](https://github.com/dendronhq/dendron/issues/452)
+- [Micharris42](https://github.com/micharris42)
+  - [issue with backslash in preview](https://github.com/dendronhq/dendron/issues/450)
+You can see an overview of all roles [[here|dendron.community.roles]]
+### Version Numbers
+This release comes with the following versions:
+- dendron plugin: 0.25
+- dendron markdown preview: 0.10.19
+- dendron cli: 0.25
+- dendron 11ty: 1.25
+- dendron plugin and dendron markdown preview will be auto-installed by VSCode
+- See the upgrade instructions [[here for dendron-11ty and dendron cli|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
+![[dendron.release.changelog#0242:#0232]]

Added: vault/dendron.release.2021-01-25.md

Files changed (1) hide show

vault/dendron.release.2021-01-25.md +48 -0

vault/dendron.release.2021-01-25.md ADDED Viewed

@@ -0,0 +1,48 @@
+---
+id: f5d459b0-01ea-4bd2-bb8b-ed7f7f7a8e0c
+title: Release Notes (version 0.26)
+desc: ''
+updated: 1611617928912
+created: 1611615493246
+---
+Dendron 0.26 has sprouted 🌱
+### Highlights
+- use note titles for link names ([[docs|dendron.topic.config#usenotetitleforlink]])
+- mermaid diagram support when publishing ([[docs|dendron.topic.markdown#diagrams]])
+- better dup note handling when publishing from multi-vault ([[docs|dendron.topic.publishing.configuration#passing-multiple-vaults]])
+### Community
+A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
+- [Handuo](https://github.com/zhanghanduo) @Handuo#0146 +#Bug Catcher
+  - error with newly installed workspaces
+- Zenen @zenen#9708
+  - issue with md outline
+- [Mark H. Choi](https://github.com/hikchoi/cerebrarium) @hikchoi#8934
+  - [Markdown Pod Tests](https://github.com/dendronhq/dendron/pull/458)
+- [Scott Spence](https://github.com/spences10) @spences10#5535 +#Bug Catcher
+  - [Windows Clipboard Issue](https://github.com/dendronhq/dendron/issues/465)
+- [Bassmann](https://github.com/Bassmann) @Bassmann#5300
+  - [Old title in daily notes](https://github.com/dendronhq/dendron/issues/461)
+### Version Number
+This release comes with the following versions:
+- dendron plugin: 0.26
+- dendron markdown preview: 0.10.22
+- dendron cli: 0.26
+- dendron 11ty: 1.26
+- dendron plugin and dendron markdown preview will be auto-installed by VSCode
+- See the upgrade instructions [[here for dendron-11ty and dendron cli|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
+![[dendron.release.changelog#0253:#0242]]

Added: vault/dendron.release.2021-02-01.md

Files changed (1) hide show

vault/dendron.release.2021-02-01.md +43 -0

vault/dendron.release.2021-02-01.md ADDED Viewed

@@ -0,0 +1,43 @@
+---
+id: b5db61c8-9d48-449a-b6b4-2750d3be1a6f
+title: Release Notes (version 0.27)
+desc: ''
+updated: 1612208194965
+created: 1612204959344
+---
+Dendron 0.27 has sprouted 🌱
+### Highlights
+- move notes between vaults using the move note command ([[docs|dendron.topic.commands#move-note]])
+- pretty 403 pages on unpublished pages ([[docs|dendron.topic.publishing.selective-publication#403-page]])
+- lots of bug fixes
+### Community
+A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
+You can see an overview of all roles [[here|dendron.community.roles]]
+- [Julien Muniak](https://github.com/Darune)
+  - [Crash when vscode is run with unsupported LOG_LEVEL](https://github.com/dendronhq/dendron/issues/466)
+- [Stedag](https://github.com/Stedag)
+  - [Refactoring results in md auto-correct](https://github.com/dendronhq/dendron/issues/467)
+### Version Numbers
+This release comes with the following versions:
+- dendron plugin: 0.27
+- dendron markdown preview: 0.10.22
+- dendron cli: 0.27
+- dendron 11ty: 1.26.2
+- dendron plugin and dendron markdown preview will be auto-installed by VSCode
+- See the upgrade instructions [[here for dendron-11ty and dendron cli|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
+![[dendron.release.changelog#0261:#0253]]

Added: vault/dendron.release.2021-02-08.md

Files changed (1) hide show

vault/dendron.release.2021-02-08.md +41 -0

vault/dendron.release.2021-02-08.md ADDED Viewed

@@ -0,0 +1,41 @@
+---
+id: c99c55b0-a709-41fe-a59e-1f1c932346dc
+title: Release Notes (version 0.28)
+desc: ''
+updated: 1612845956396
+created: 1612844876830
+---
+Dendron 0.28 has sprouted  🌱
+This week is a stability release. We've spent time fixing bugs and improving defaults so your gardens can make it through the winter.
+### Highlights
+- better default behavior for multi-vault
+- generate a diagnostics report to quickly fix issues
+- heaps of bug fixes
+### In the Works
+- We are putting the finishing touches on [managed Publishing](https://dendron.so/notes/ae4a0c98-e2ea-47e0-8a20-016eba3424be.html). Updates on the launch later this week (for real this time) 😅
+### Community
+A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
+You can see an overview of all roles [[here|dendron.community.roles]]
+- [Mark H. Choi](https://github.com/hikchoi/cerebrarium) @hikchoi#8934
+    - [don't delete text when extracting fro non-vault file](https://github.com/dendronhq/dendron/pull/471)
+- [Nikita Voloboev](https://github.com/nikitavoloboev) @nikivi#5640  `+@Horticulturalist`
+    - [add default description to published sites](https://github.com/dendronhq/dendron/pull/472)
+### Version Number
+This release comes with the following versions:
+- dendron plugin: 0.28
+- dendron cli: 0.28.2
+- dendron 11ty: 1.28.3
+- dendron plugin and dendron markdown preview will be auto-installed by VSCode
+- See the upgrade instructions [[here for dendron-11ty and dendron cli|dendron.guides.upgrading#dendron-cli-and-dendron-11ty]]
+![[dendron.release.changelog#0272:#0261]]

Added: vault/dendron.release.2021-02-15.md

Files changed (1) hide show

vault/dendron.release.2021-02-15.md +31 -0

vault/dendron.release.2021-02-15.md ADDED Viewed

@@ -0,0 +1,31 @@
+---
+id: 7aab0296-c1be-4f27-af22-1d97293da7d6
+title: Release Notes (version 0.29)
+desc: ''
+updated: 1613450410034
+created: 1613449712126
+---
+Dendron 0.29 has sprouted  🌱
+### Highlights
+- managed publishing (early preview) is here
+- frontmatter can now be folded
+- last modified times on published pages
+- lots of performance improvements
+- lots of bug fixes
+### Community
+A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
+You can see an overview of all roles [[here|dendron.community.roles]]
+- [Peter Ritchie](https://github.com/peteraritchie)
+  - [fix broken link in docs](https://github.com/dendronhq/dendron/pull/378)
+- [Mark H. Choi](https://github.com/hikchoi/cerebrarium) @hikchoi#8934
+  - [Add option to configure human readable ts formatting](https://github.com/dendronhq/dendron/pull/479)
+  - [Provide folding range in frontmatter](https://github.com/dendronhq/dendron/pull/487)
+- [Daniel Chapman](https://github.com/dschapman)
+    - [Manually Triggering Intellisense doesn't work if an alias is more than one word](https://github.com/dendronhq/dendron/issues/473)
+![[dendron.release.changelog#0281:#0272]]

Added: vault/dendron.release.2021-02-22.md

Files changed (1) hide show

vault/dendron.release.2021-02-22.md +39 -0

vault/dendron.release.2021-02-22.md ADDED Viewed

@@ -0,0 +1,39 @@
+---
+id: 8d76cb22-f14c-438c-821e-37c91d1b857a
+title: Release Notes (version 0.30)
+desc: ''
+updated: 1614139494099
+created: 1614059104275
+---
+Dendron 0.30 has sprouted  🌱
+### Highlights
+- experimental nunjucks templates
+- support for private vaults
+- dynamic popovers for unpublished links
+- lots of enhancements and bug fixes
+### In the Works
+- custom domains for [[managed publishing|dendron.rfc.2-managed-publishing]]
+### Community
+A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
+You can see an overview of all roles [[here|dendron.community.roles]]
+- [flammehawk](https://github.com/flammehawk) @fudo#1010
+  - [issue labeling automation](https://github.com/dendronhq/dendron/pull/453)
+- [Bassmann](https://github.com/Bassmann) @Bassmann#5300
+  - issue with doctor cli command
+- [Bryan Jenks](https://github.com/tallguyjenks) @tallguyjenks#3567 `+@Taxonomist`
+  - fix bad links
+- [Cameron Yick](https://github.com/hydrosquall) @cameron#9185  `+@Planter` `+@Taxonomist`
+    - fix typpo
+- [Mandar Vaze](https://github.com/mandarvaze)
+    - fix bad doc link
+- [Stedag](https://github.com/Stedag)
+    - fix typo
+![[dendron.release.changelog#0292:#0281]]

Added: vault/dendron.release.2021-03-01.md

Files changed (1) hide show

vault/dendron.release.2021-03-01.md +41 -0

vault/dendron.release.2021-03-01.md ADDED Viewed

@@ -0,0 +1,41 @@
+---
+id: 1dad9378-8fcf-4859-bede-cc44279ba12d
+title: Release Notes (version 0.31)
+desc: ''
+updated: 1614640820802
+created: 1614636249937
+---
+Dendron 0.31 has sprouted  🌱
+This is probably the biggest release we've had in 2021!
+Lots of goodies to make dendron and [[multi vault|dendron.topic.multi-vault]] work better. Enjoy responsibility :)
+### Highlights
+- [[cross vault links|dendron.topic.links#cross-vault-links]] let you specify links to notes in multi-vault workspaces
+- note references now work across vaults
+- backlinks are also generated during publishing
+- you can now extend dendron with [[custom pods|dendron.topic.pod.custom]] to publish your notes to different destinations
+- usual round of bug fixes and performance improvements
+### Community
+A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
+You can see an overview of all roles [[here|dendron.community.roles]]
+- [Bassmann](https://github.com/Bassmann) @Bassmann
+    - [Remove vault doesn't remove entry from payload in dendron.yml](https://github.com/dendronhq/dendron/issues/505)
+- [Philip Whiteside](https://github.com/PhilipWhiteside)
+    - [Issue selecting secondary vault](https://github.com/dendronhq/dendron/issues/495)
+    - [Can't open assets from secondary vault](https://github.com/dendronhq/dendron/issues/504)
+- [Oli Crask](https://github.com/olivercrask) @Oli916
+    - [Published multi-vault navigation pane opens incorrect dropdown](https://github.com/dendronhq/dendron/issues/501)
+- @pcblazef +`@BugCatcher`
+    - [links not clickable inside ref](https://github.com/dendronhq/dendron/issues/511)
+- [Nikita Khomitsevych](https://github.com/hamsternik)
+    - fix bad link
+- [Simon J S Liu](https://github.com/wind13) @Simon Liu +`@BugCatcher`
+    - [Can not search Chinese in web site](https://github.com/dendronhq/dendron/issues/499)
+![[dendron://dendron-site/dendron.release.changelog#0302:#0292]]

Added: vault/dendron.release.2021-03-08.md

Files changed (1) hide show

vault/dendron.release.2021-03-08.md +36 -0

vault/dendron.release.2021-03-08.md ADDED Viewed

@@ -0,0 +1,36 @@
+---
+id: e4be70f5-e035-4e11-b915-3a3508cd9d6b
+title: Release Notes (version 0.32)
+desc: ''
+updated: 1615242232695
+created: 1615241525434
+---
+Dendron 0.32 has sprouted  🌱
+### Highlights
+- custom domain names for managed publishing
+- changelog for published pages (experimental)
+- usual round of bug fixes and performance improvements
+### Community
+A big **thanks** to the following gardeners that brought up issues, contributions, and fixes to this release :man_farmer: :woman_farmer:
+You can see an overview of all roles [[here|dendron.community.roles]]
+- [Cameron Yick](https://github.com/hydrosquall) @cameron#9185
+  - [Paste link command](https://github.com/dendronhq/dendron/pull/512)
+- [Derek Ardolf](https://github.com/ScriptAutomate) @ScriptAutomate#6833
+  - fix typos
+- [Mark H. Choi](https://github.com/hikchoi/cerebrarium) @hikchoi#8934
+  - [Clean up config after vault remove command by hikchoi · Pull Request #517 · dendronhq/dendron](https://github.com/dendronhq/dendron/pull/517)
+  - [Consolidate testing convention by hikchoi · Pull Request #527 · dendronhq/dendron](https://github.com/dendronhq/dendron/pull/527#pullrequestreview-605945027)
+- [Shekhar Neupane](https://github.com/neupsh) `+@taxonomist`
+  - fix typos
+- [Ben Vautier](https://github.com/Orcomp) @bvautier#1882 `+@taxonomist`
+  - add windows dev docs
+- [Boxian](https://github.com/b0xian) @boxian#6506 `+@bugcatcher`
+    - [True Portability for Dendron · Issue #522 · dendronhq/dendron](https://github.com/dendronhq/dendron/issues/522)
+![[dendron.release.changelog#0313:#0310]]

Added: vault/dendron.release.changelog.0-1-x.md

Files changed (1) hide show

vault/dendron.release.changelog.0-1-x.md +936 -0

vault/dendron.release.changelog.0-1-x.md ADDED Viewed

@@ -0,0 +1,936 @@
+---
+id: ed4162aa-5474-4483-9fbc-c0b505310c59
+title: 0.1.X
+desc: ''
+updated: 1614924050223
+created: 1610397097347
+---
+## 0.19.3
+### Bug Fixes
+- be able to name remote vaults ([6da3973](https://github.com/dendronhq/dendron/commit/6da39730f735f4700479f002f57d2a7802398ff5))
+- doctor command shouldn't create stubs ([e812f34](https://github.com/dendronhq/dendron/commit/e812f34246d88b007fb45ca03443a74ac27a5e62))
+- help command not working ([02fc08a](https://github.com/dendronhq/dendron/commit/02fc08a907e196b39c23db36b82565c15588673f))
+- nested git repos not showing up in source control view ([37adc5e](https://github.com/dendronhq/dendron/commit/37adc5e528e0b9fa6c86105b39ebb40384023da4))
+- clicking a stub on tree view would show a false error ([ea0e17e](https://github.com/dendronhq/dendron/commit/ea0e17e7ec8afed44cee1fd0fe442ba4c2064f92))
+## 0.19.2
+### Features
+#### Dendron Seed Bank
+((ref:[[dendron.topic.seed-bank]]))
+#### Support refactor for multi-vault
+One of our most requested features for multi-vault is now out. Refactor will now work across multiple vaults. All rename operations take place in the same vault as the file being renamed (so a refactor operation that affects files in multiple vaults will end up renaming files within each vault). You can see an example of this below:
+```
+.
+├── vault1
+│   └── bond.one
+└── vault2
+    └── bond.two
+```
+- after refactoring `bond -> james`
+```
+.
+├── vault1
+│   └── james.one
+└── vault2
+    └── james.two
+```
+#### Support Specifying Vault Location when Creating a Note
+((ref:[[dendron.topic.multi-vault]]#specify vault location when creating a note,1:#*))
+### Enhancements
+- add aws to the seed bank ([818bc05](https://github.com/dendronhq/dendron/commit/818bc0510e3b3b99057ef7cda8d9c61be2b6ebc6))
+- nicer refactor formatting ([0e7749a](https://github.com/dendronhq/dendron/commit/0e7749a175a0ce80903cde5c9773649779100a9c))
+- add remote vault to gitignore if exist ([1c252db](https://github.com/dendronhq/dendron/commit/1c252db60c0ea69be8dd10c1768c2dd302711e13))
+- initialize all remote vaults on startup ([1919fe4](https://github.com/dendronhq/dendron/commit/1919fe4e6d853d1f6ef63564ebbcc9af1e11a41a))
+- write remote url to dendron config ([2a285ea](https://github.com/dendronhq/dendron/commit/2a285eacaeef8224d2a3530dc991b4977443c039))
+- add github sponsor badge on github repository to recruit more [[environmentalists|dendron.community.roles#environmentalist]] 👨‍🌾 👩‍🌾
+### Bug Fixes
+- completion on schema suggestions ([223d6a5](https://github.com/dendronhq/dendron/commit/223d6a501bd9e51331d28e21d77408b7ca3fba50))
+## 0.19.1
+### Bug Fixes
+- image preview regex match wrong range
+## 0.18.2
+### Features
+- support image hover ([8fee313](https://github.com/dendronhq/dendron/commit/8fee313785dfc4ac2564f74911a4b51879be0673))
+  ```
+  - you can now hover over markdown image links and get the image preview
+  ```
+  <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/82119bc9ee184e3ca8e619c3d7e48209" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+### Enhancements
+- faster completion ([d9d4598](https://github.com/dendronhq/dendron/commit/d9d4598c1996fdb5eb24e4bda0e51e777b476f6e))
+### Bug Fixes
+- doctor errors when backfilling frontmatter ([862e917](https://github.com/dendronhq/dendron/commit/862e9173e92a2e5d964273bb87c19e79177a6200))
+- properly parsing links that start at beginning of line ([b2dbdfc](https://github.com/dendronhq/dendron/commit/b2dbdfc9e49aa1fa74d5097500eeaddf05bf7ccc))
+- limit completion prompts to inside wiki links ([f49972e](https://github.com/dendronhq/dendron/commit/f49972ee436f9f637bd68729e702ba2169e68faf))
+- adding local vault with fail if using relative path ([fb202e9](https://github.com/dendronhq/dendron/commit/fb202e91e501cfd5506fd73c9a005807954e48d3))
+- make completion match the whole link ([d9d4598](https://github.com/dendronhq/dendron/commit/d9d4598c1996fdb5eb24e4bda0e51e777b476f6e))
+- tree view containing out of date hierarchy
+- alias notes will no longer display alias portion as part of the link when publishing
+## 0.18.1
+### Features
+#### Support adding remote vaults
+- commit: ([d7501b9](https://github.com/dendronhq/dendron/commit/d7501b9a5cb116faae64d26798cfd7ccfc73a4b0))
+You can now natively add published Dendron git repos as a _remote vault_ inside Dendron. These vaults are stored in a custom `repos` folder underneath your `workspaceRoot`. Since a remote vault is just a git repo, you are able to perform all the usual git operations on it like `push`, `pull`, `merge`, and `blame`.
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/ef3fa948460c4f2cb4f7a7b8242579d1" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+### Enhancements
+- support pods for multi-vault ([661fe21](https://github.com/dendronhq/dendron/commit/661fe218d448e6f32f86bf60dabe635b71d67251))
+- much faster lookup performance for large vaults 🚀🚀🚀  ([3ddeba8](https://github.com/dendronhq/dendron/commit/3ddeba8a596be4bc9316e0cc5e63025d7bf4460f))
+- support [[sibling nav|dendron.topic.commands#go-next-sibling]] for multi-vault ([235bfc7](https://github.com/dendronhq/dendron/commit/235bfc77505b403bf32c78ce3df6b7005c37dfba))
+### Bug Fixes
+- publishing fails in some cases when multi-vault is enabled ([0ebac81](https://github.com/dendronhq/dendron/commit/0ebac8191291f48ab42fbc30279e9615c96a5245))
+- journal and scratch notes fail in some cases for multi-vault ([5c04ccd](https://github.com/dendronhq/dendron/commit/5c04ccd666511abb79554b7a24c02efd46d93c3a))
+- multiple commands not working properly for multi-vault([fd5a381](https://github.com/dendronhq/dendron/commit/fd5a381674384588850b07b193fc0bf609abc0fd))
+### House Cleaning
+- breaking: the [[go to sibling|dendron.topic.commands#go-next-sibling]] commands have a new keyboard shortcut since the old one was conflicting with the vscode default. the new shortcuts are `ctrl+shift+]` and `ctrl+shift+[`
+## 0.17.2
+### Features
+#### Dendron Web UI 🚧
+During office hours and onboardings, many of you said how you loved Dendron's functionality but wished that it was a little easier to use, especially on the UI front.
+This is why I'm excited to introduce Dendron's first Web UI - an interface build using modern web technologies integrated into VSCode.
+This initial launch features the Dendron Configuration editor. Prior to the UI, you would have to manually edit YAML to update the configuration. With the web ui, you no longer have to understand YAML and your changes will be validated before being saved.
+The configuration editor is just the first step in making Dendron easier to use and expect to see more updates on this front soon.
+Note that the Web UI is still deemed experimental and functionality like keyboard shortcuts currently don't work.
+Special thanks to [Tyler Nieman](https://github.com/tsnieman) for the UI work!
+((ref:[[dendron.topic.commands]]#configure,1:#*))
+### Enhancements
+- update config commands ([44dce76](https://github.com/dendronhq/dendron/commit/44dce76b6fd447cd29a2f4f594632ef758eff927))
+- enable rename with multi-vault ([e26b294](https://github.com/dendronhq/dendron/commit/e26b294e8bbe1e49e44318152c247595e82639bb))
+- tree view and backlinks panel no longer appear when Dendron is not active (thank you [Christopher Corley](https://github.com/cscorley))
+### Bug Fixes
+- rename would fail if backlink existed at root note
+- numerous fixes to refactor hierarchy
+### House Cleaning
+- the `Dendron: Configure` command will now launch the config editor with the web ui
+- the old `Dendron: Configure` command as been renamed to `Dendron: Configure (yaml)`
+## 0.17.1
+### Features
+#### Automatic Hover's for Links
+- add hover provider ([8d19a1b](https://github.com/dendronhq/dendron/commit/8d19a1b47f114ae738f7483fd751b62f68b46d24))
+You can now preview notes and references inside the editor as a hover without ever opening the link. Previews are compatible with note references and will show references as inlined markdown.
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/aee387226d5c4bb0a4e38cee76a1aa3e" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+### Bug Fixes
+- **workbench:** copy header cmd will sometimes chop of last character ([34c2530](https://github.com/dendronhq/dendron/commit/34c253036cf959ef00620db9063c8de36ae9c848))
+- **markdown:** relative links sometimes don't resolve ([c1ffa54](https://github.com/dendronhq/dendron/commit/c1ffa54ab780bec98cb5b322b4d0905cc26acce7))
+### Work in Progress
+- continued multi-vault compatibility for existing features
+- integrating [Dendron's first Web UI component](https://github.com/dendronhq/dendron/pull/351)
+- backend changes to enable new [[multi vault layout|dendron.roadmap.project.n.2020.multi-vault#initialization]]
+- heaps of performance and stability improvements
+## 0.16.3
+### Enhancements
+- **language**: better completion on partial links  ([e7489b3](https://github.com/dendronhq/dendron/commit/e7489b324fb8b5b1a0cb3daf4bd33978073bd90a))
+- **workbench**: remove color theme and minimap presets ([6b6bd8d](https://github.com/dendronhq/dendron/commit/6b6bd8d1b866bfe881b8ed7c341e5f2191bfa741))
+- **publishing**: support relative links in publishing ([d7d612d](https://github.com/dendronhq/dendron/commit/d7d612d00bf0fedfc5e7dc9beda1e00927be83a9))
+- **notes:** rename the frontmatter title when note is renamed ([32c77a1](https://github.com/dendronhq/dendron/commit/32c77a1a97162150b88c97c9266bd2a42a816aa0))
+- **workbench:** auto upgrade deprecated workspace settings
+### Bug Fixes
+- **language**: re-enable preview functionality when peeking at a definition ([afe71c4](https://github.com/dendronhq/dendron/commit/afe71c41daff3acc935cb5bed7b51d20ef8e6267))
+- **language**: creating a note by going to its definition now respects schema templates
+- **workbench**: initialize dendron in the absence of a workspace file ([c1aabb4](https://github.com/dendronhq/dendron/commit/c1aabb4a6b2084990269ea169c1a90d800b430c3))
+- **workbench**: cancel adding a vault if input is blank ([86baed6](https://github.com/dendronhq/dendron/commit/86baed6e0938132709e4cfbd2008f1f8fadc77cb))
+- **pods:** publish issue when multi-vault is enabled ([cc50327](https://github.com/dendronhq/dendron/commit/cc503276a0ca0545e2793449f7382bc810216377))
+- **ui:** note will show up in wrong place in treeview when multi-vault is enabled ([6daeebc](https://github.com/dendronhq/dendron/commit/6daeebc7bd2bbc68fc105766d30bc10444bcaf61))
+## 0.16.2
+- NOTE: with this change, Dendron now has all the functionality of **Dendron Markdown Notes** built-in (and then some). To make sure you get the new link functionality, uninstall Dendron Markdown Notes
+![uninstall ](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/etc.install.jpg)
+### Features
+#### Support Relative Wiki Links
+You can now navigate to a specific section within a note using relative wiki links: `[[foo#header]]`
+Note that the header is expected in [github slug](https://github.com/gosimple/slug) format. This means that spaces and special characters should be replaced with `-`.
+- **NOTE**: Relative wiki links currently don't work in the markdown-preview
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/b21501b47e64449882a369590a630d7f" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+#### Copy Relative Wiki Links
+Similarly to copying a note ref, if you select any part of a header while running `Copy Note Link`, a relative wiki-link will be automatically generated.
+((ref:[[dendron.topic.commands]]# copy note link:# *))
+#### All link features are now multi-vault aware
+Link related features like navigation and auto complete can now detect notes in all vaults.
+When the same note exists in multiple vaults, Dendron will show you a prompt to pick the note you want to navigate to.
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/1108e35e262c4d428629d0a4034090d0" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+#### Link Completion with Aliases
+You can now auto complete notes that have aliases. This was a common issue for folks that were using [[pretty tags|dendron.topic.tags]]
+### Bug Fixes
+- Issue with creating notes with same name in a new vault
+### House Cleaning
+- remove dependency on markdown-notes
+## 0.16.1
+### Bug Fixes
+- new dendron installation missing welcome note
+## 0.15.3
+### Features
+#### Better Lookup Performance 🚀 🚀 🚀
+We've made a whole bunch of optimizations to make lookup hum. You should notice everything about it feel a little faster now
+Changelog:
+- **lookup:** multiple lookup optimizations([f14eed8](https://github.com/dendronhq/dendron/commit/f14eed8da822eb75f130edb7364a1f9f0c2fe354))
+- **lookup:** intelligently debounce queries ([2f0ac56](https://github.com/dendronhq/dendron/commit/2f0ac56bd6f64d0b99fcb82d6effa9f062d18fc2))
+### Enhancements
+- update getting started ([af5dde9](https://github.com/dendronhq/dendron/commit/af5dde91d153ce46089c8688caec0e583eddb939))
+  - instead of 100+ notes, new vaults will be initialized with a single quickstart note (with links to the 100+ notes)
+- better logging ([2d7fd78](https://github.com/dendronhq/dendron/commit/2d7fd780d3c548a362dcf01a2620409b1bcdff3e))
+  - let logs talk for you the next time you submit [an issue](https://github.com/dendronhq/dendron/issues/new?assignees=&labels=&template=bug_report.md&title) (no 🌲 harmed in this process)
+- nicer error messages ([e1e87a1](https://github.com/dendronhq/dendron/commit/e1e87a16186b1e8b8aae6f77fe8a2c5c865c4071))
+  - we'll let you know if you need to submit an issue instead of giving you the silent treatment
+- keep old log files ([3f1362c](https://github.com/dendronhq/dendron/commit/3f1362c224ff7dae5de721dd2f2c8cba22db4d84))
+  - dendron currently wipes all logs on startup. this change makes it keep around the last log for debugging purposes
+### Bug Fixes
+- creating scratch notes can sometimes fail ([c31c611](https://github.com/dendronhq/dendron/commit/c31c611d975b8eeee4f63abec742edf88dac66ac))
+- sync issues btw server and client nodes that would cause certain commands to fail  ([a446aba](https://github.com/dendronhq/dendron/commit/a446aba9d931d7732553e1ecb43302208d6f798a))
+## 0.15.2
+### Features
+#### Experimental Multi-Vault Support
+(Early Experimental ) [[Multi Vault Support|dendron.roadmap.project.n.2020.multi-vault]]  is here! Multi Vault lets you add additional [vaults](https://dendron.so/notes/c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50.html#vaults-) to your Dendron workspace.
+Each vault is logically separate (they reside in separate directories) but can be universally queried using lookup.
+Multi vault enables a bunch of exciting use cases.
+((ref:[[dendron.roadmap.project.n.2020.multi-vault]]#use cases,1:#*))
+Currently, the following commands are supported with multi-vault:
+- Lookup
+- Deleting a Note
+- Navigating to a note using Tree View
+Other commands like rename/refactor will still work when performed in your primary vault. They will probably not work if performed against a note not inside your primary vault.
+When you use **Lookup** to create a new note with multi vault, the note will be created inside the same vault as the current opened note. **Lookup** will also show you the vault that each note belongs to while performing lookup.
+Currently known issues (with supported commands):
+- unable to create a note using Lookup that has the same name as an existing note inside **any** of your vaults
+- unable to navigating to the root of a vault using Tree View
+#### Vault Add Command
+Add a new vault to your workspace.
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/b4171372f9794dd7be609c043f343fa3" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+#### Vault Remove Command
+Remove a vault from your workspace. Note that the underlying files wil **not** be deleted - the vault will lose its association with your workspace.
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/307effc22b8d4c59a32933529a8393e1" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+### Enhancements
+### Bug Fixes
+- **engine:** init with empty config won't throw error ([7beb90f](https://github.com/dendronhq/dendron/commit/7beb90fa243bc73563a3ce16b5305345f7348d9f))
+- **engine:** don't delete old note if new note wasn't created by rename ([de44f9f](https://github.com/dendronhq/dendron/commit/de44f9f4d38651d75433ae885fdc78bb762fb1f6))
+- **notes:** fix issue when importing note that already exists ([a08a34a](https://github.com/dendronhq/dendron/commit/a08a34a0563bb4047bd9c7cfc5f2bf150873fdc8))
+### House Cleaning
+- vault metadata will be added to `dendron.yml`
+- `dendron.yml` comments will be stripped on workspace initialization
+## 0.15.1
+### Features
+#### Wildcard Note Ref Links
+- **refs:** wildcard note ref links ([98a1177](https://github.com/dendronhq/dendron/commit/98a117715a967492ab9d7b8749d964b07bde4055))
+((ref:[[dendron.topic.refs]]#wildcard note refs,1))
+#### Dendron: Configure Command
+- **workbench:** add configure command ([db51dc3](https://github.com/dendronhq/dendron/commit/db51dc35864d0c4434f70620ef0e88451c198fa4))
+This is a quick way to update the `dendron.yml` file. You can run it by using `Dendron: Configure`
+### Bug Fixes
+- **notes:** fix issue when importing note that already exists ([a08a34a](https://github.com/dendronhq/dendron/commit/a08a34a0563bb4047bd9c7cfc5f2bf150873fdc8))
+### House Cleaning
+- add `.dendron.ws` file under workspace to store workspace specific metadata
+## 0.14.2
+### Features
+### Enhancements
+- **pods:** better markdown import pod  (d1eaa264)
+  - address multiple edge cases that would cause import pod to fail
+  - auto-convert wiki-links from folder-based systems like obsidian into dendron
+- **cli:** launch engine server using cli ([25eae3f](https://github.com/dendronhq/dendron/commit/25eae3fddd6a2d26dcf9e2f3e664b377c2cca978))
+((ref:[[dendron.topic.cli]]#launchengineserver:#*))
+- **workspace:** write server port in workspace ([6a0ff84](https://github.com/dendronhq/dendron/commit/6a0ff845ebbf010073b271123779fc3f56ac2821))
+  - used by bundled extensions to talk to dendron server
+- **engine:** add sync method ([ec58d39](https://github.com/dendronhq/dendron/commit/ec58d395003640384b7764f4f8b483429cc1ece3))
+  - used by bundled extensions to talk to dendron server
+### Bug Fixes
+- **engine:** properly handle \* in refs when refactoring ([704a14f](https://github.com/dendronhq/dendron/commit/704a14f17196e18cb5b26f5fc98ed9f8d492e16a))
+- **workbench:** fix daily journal note command signature ([5ec96ef](https://github.com/dendronhq/dendron/commit/5ec96efd9a006e5e5999f2704dfb3d1e97e60a5c))
+## [0.14.1](https://github.com/dendronhq/dendron/compare/v0.14.1-alpha.7...v0.14.1) (2020-11-05)
+### Features
+#### Lookup Copy WikiLink Modifier
+- **lookup:** copy note link cmd ([e38743d](https://github.com/dendronhq/dendron/commit/e38743ddbac8486f2ac778bd546a6373a15a4f6d))
+((ref:[[dendron.topic.lookup.modifiers]]#copywikilink,1:#*))
+#### Lookup Multi-Select Modifier
+- **lookup:** support multi-select ([b409c05](https://github.com/dendronhq/dendron/commit/b409c05d3b19797de714dbf10b6a4249758eae8a))
+((ref:[[dendron.topic.lookup.modifiers]]#multiselect,1:#*))
+### House Cleaning
+#### Code Cleanup
+With the server migration behind us, we took some time to make Dendron more hygenic by removing old code and consolidating existing code. All in all, we eliminated ~8k lines. If you are currently working on a branch, I suggest you merge with master to get the latest changes 😅
+- before cleanup
+```
+-------------------------------------------------------------------------------
+Language                     files          blank        comment           code
+-------------------------------------------------------------------------------
+JSON                            73              6              0          72744
+TypeScript                     246           3089           3089          31790
+Markdown                        50           4682              0           5947
+JavaScript                      16            168             76           1349
+Bourne Shell                    23             40              9            179
+YAML                            13              3              3            158
+CSS                              2             17             32             72
+HTML                             1              0              0             14
+SVG                              1              0              0             12
+-------------------------------------------------------------------------------
+SUM:                           425           8005           3209         112265
+-------------------------------------------------------------------------------
+```
+- after cleanup
+```
+-------------------------------------------------------------------------------
+Language                     files          blank        comment           code
+-------------------------------------------------------------------------------
+JSON                            73              6              0          72745
+TypeScript                     224           2343           1810          24352
+Markdown                        34           4772              0           5974
+JavaScript                      16            168             76           1349
+Bourne Shell                    24             40              9            181
+YAML                             6              3              3             78
+CSS                              2             17             32             72
+HTML                             1              0              0             14
+SVG                              1              0              0             12
+-------------------------------------------------------------------------------
+SUM:                           381           7349           1930         104777
+-------------------------------------------------------------------------------
+```
+## 13.6
+### Features
+#### Add Contribute Command
+- **workbench:** ([130a58a](https://github.com/dendronhq/dendron/commit/130a58a62cc40eb4178afac554f8f4ff30c93055))
+((ref:[[dendron.topic.commands]]#contribute:#*))
+#### Add Snapshot Capability to Dendron
+- **workbench:**  ([3af64b7](https://github.com/dendronhq/dendron/commit/3af64b701d47ed28818d7e6017c758f63be617f0))
+((ref:[[dendron.topic.capabilities.snapshot]]#Snapshots:#*))
+## [0.13.5](https://github.com/dendronhq/dendron/compare/v0.13.4...v0.13.5) (2020-10-28)
+### Bug Fixes
+- **workbench:** tree view can delete notes with caps ([d37926d](https://github.com/dendronhq/dendron/commit/d37926d7f38d784f847a4c2a58fb75ba7c03b0e0))
+## [0.13.4](https://github.com/dendronhq/dendron/compare/v0.13.4-alpha.1...v0.13.4) (2020-10-28)
+### Features
+#### Migrate Existing Workspaces to Server Mode
+- commit ([d19b6ec](https://github.com/dendronhq/dendron/commit/d19b6ecb97fb60d8706e14f0181795113b5e108b))
+This is the last phase in Dendron's server mode migration. All new workspaces are already running in server mode as well as well as users that have opted into it. This update transparently migrates remaining workspaces to server mode.
+As a reminder, [[server mode|dendron.roadmap.project.n.2020.server-migration]] is a re-architecture of Dendron that enables both better performance and a vast array of new features.
+Finally, we do have an escape valve in things something goes terribly wrong. You can set the following option to revert server mode behavior. If you end up using this, please also cut as [a ticket](https://github.com/dendronhq/dendron/issues/new?assignees=&labels=&template=bug_report.md&title=) or a message in [discord](https://discord.gg/QbKsNx).
+### Enhancements
+- **notes:** selection2link will auto generate a title based on the selection ([9964339](https://github.com/dendronhq/dendron/commit/9964339138bde18dc022fdd62ce9ba9d529cfa2b))
+- **workbench:** graceful failure on bad schema ([4db5064](https://github.com/dendronhq/dendron/commit/4db5064e4eef61d9c95b9abe34f2dec41550bd9d))
+  - instead of refusing to initialize, Dendron will skip bad schemas and generate an error report post-startup
+- **workbench:** nicer error messages  ([9e371e1](https://github.com/dendronhq/dendron/commit/9e371e132b565ae2abebaa2bf1307a5a03a91b9b))
+  - certain errors now have human friendly messages instead of JSON goop
+### Bug Fixes
+- **workbench:** read json config with comments ([1741553](https://github.com/dendronhq/dendron/commit/1741553695b1c7cced54bf04b26700076a38a19c))
+  - Dendron gets sad if your workspace has comments
+### Community
+#### Horticulturalist
+Dendron now has a new role -> the **Horticulturalist**. These are folks who have contributed to the Dendron code base: 👨‍🌾👩‍🌾
+Kudos to **@britt#3020** and **@lukecarrier#2081** for being the first to earn this distinction!
+#### Dendrologist
+Excited to welcome a new dendrologist --> @I'm a lightbulb#6986
+@I'm a lightbulb#6986 was one of our earliest users and one of the first to [publish](https://dendron.so/notes/3a82c5ff-7945-46ae-8bf9-3b2275fc6642.html#jacks-page) using dendron.
+As a reminder, dendrologist are active members of the community who are recognized with said title and a few additional discord super powers.
+## [0.13.3](https://github.com/dendronhq/dendron/compare/v0.13.3-alpha.1...v0.13.3) (2020-10-24)
+### Features
+#### Direct Child Filter
+- **lookup:** support direct child filter ([1cae082](https://github.com/dendronhq/dendron/commit/1cae08294baa844c0c0ee3c8d390e337bd6172be))
+((ref:[[dendron.topic.lookup]]#filter toggle,1:#*))
+- you can create a keyboard shortcut to do a lookup with the direct child filter pre-selected
+  ((ref:[[dendron.topic.lookup.modifiers]]#filtertype:#*))
+### Enhancements
+- **publish:** be able to set config for all hierarchies ([a27d94a](https://github.com/dendronhq/dendron/commit/a27d94a3c469a4efaf2ee8c2bca40a8a471773f2))
+  ((ref:[[dendron.topic.publishing.configuration]]#config:#*))
+- **schema:** add custom props from schema template ([5264544](https://github.com/dendronhq/dendron/commit/52645449b8e155e168baaac0fa4e99903efafcf0))
+((ref:[[dendron.topic.schema]]#schema templates,1:#*))
+- **workbench:** reload index re-create root if not exist ([c66e242](https://github.com/dendronhq/dendron/commit/c66e242bac91c73404a5dd21ed3813c0dc2f022b))
+  - dendron requires `root.md` and `root.schema.yml` to start indexing and would previously throw an error if these files were deleted
+  - this change will create these files within the vault instead of throwing said error
+### Bug Fixes
+- **comp:common-server:** don't throw error on missing log vars ([9d00e55](https://github.com/dendronhq/dendron/commit/9d00e55b2104efa7739ec94f0bb2793daa888450))
+- **notes:** refactor will miss links in newly created notes ([c8a5dde](https://github.com/dendronhq/dendron/commit/c8a5dde2ca46e2402bc50b1a8f635d9fb5318c9d))
+- **lookup:** don't update lookup text unless a _note btn_ is pressed ([30140f7](https://github.com/dendronhq/dendron/commit/30140f7a16c6fb5ab81a9eae8af13f17575c78f3))
+- **workbench**: Doctor command will create two `doc` directories if no `doc` directory is found ([43f7bfc9](https://github.com/dendronhq/dendron/commit/43f7bfc9)) --> ( 🙏 thanks to [Britt](https://github.com/bs) for the pull request)
+### House Cleaning
+#### Dendron: Change Workspace will no longer create a workspace if no workspace exists
+Previously, if you wanted to use an existing folder (aka vault) with a workspace, we recommended you run `Change Workspace` which would create a Dendron workspace **inside** the folder if it didn't exist. This turns out to be an anti-pattern that interferes with features like publishing which expect the workspace to be in a separate folder from its vaults.
+## [0.13.2](https://github.com/dendronhq/dendron/compare/v0.13.2-alpha.2...v0.13.2) (2020-10-22)
+### Features
+#### Pod Publishing
+- **pods:** add publish pod cmd ([8947a60](https://github.com/dendronhq/dendron/commit/8947a60cbc2e76f00d214a1913952c58db86f2f1))
+In addition to **import** and **export**, you can now also **publish** notes with pods.
+((ref:[[dendron.topic.pod]]#publish,1:#*))
+#### Realtime Schema Validation
+- **schemas:** realtime schema validation (server mode) ([42191bcd](https://github.com/dendronhq/dendron/commit/42191bcd))
+You will now get a warning if you are trying to save a badly formatted schema.
+### Enhancements
+- **publishing:** preserve abbreviations ([06d9191](https://github.com/dendronhq/dendron/commit/06d91912b34bc5f81b20fce77652366c501865ec)) --> thank you [Luke Carrier](https://github.com/LukeCarrier) for the pull request
+- **pods:** add json publish pod ([127dd7c](https://github.com/dendronhq/dendron/commit/127dd7c02a0081b027e06c40d6189904c5da0694))
+- **pods:** add markdown publish pod ([127dd7c](https://github.com/dendronhq/dendron/commit/127dd7c02a0081b027e06c40d6189904c5da0694))
+- **pods:** update placeholder text ([57a4af8](https://github.com/dendronhq/dendron/commit/57a4af8887404c21d07b45a3a565516bf73cc944))
+- **refs:** render error when ref doesn't exist ([ba1be1a](https://github.com/dendronhq/dendron/commit/ba1be1a12c4a1742e93ab4058d0f132b320be539))
+### Breaking
+- `dendron.pod.file` has been renamed `dendron.markdown`
+- `dendron.pod.json` has been renamed `dendron.json`
+### Documentation Updates
+#### Pods
+Documentation for pods has been re-written to reflect recent changes with pods
+((ref:[[dendron.topic.pod]]#pods:#*))
+## [0.13.1](https://github.com/dendronhq/dendron/compare/v0.13.1-alpha.2...v0.13.1) (2020-10-21)
+### Features
+#### Generate table of contents when Publishing
+- **publishing:** generate toc when publishing ([53ee270](https://github.com/dendronhq/dendron/commit/53ee270c89f530b9224f33a28dc811de7e5cb2ad))
+((ref:[[dendron.topic.publishing.configuration]]#toc:#*))
+- **publishing:** set frontmatter overrides globally when publishing ([782d637](https://github.com/dendronhq/dendron/commit/782d6374c55b00bcda36da9149fb2cedeac0c3d9))
+### Enhancements
+- **lookup:** add contrast btw note/schema lookup ([4faec8e](https://github.com/dendronhq/dendron/commit/4faec8e4548a80eb56469c46efadd608c26e0230))
+    ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/change.lookup-note.jpg)
+    ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/change.lookup-schema.jpg)
+### Bug Fixes
+- **publish:** issues with Publish command in server mode ([7f3789a](https://github.com/dendronhq/dendron/commit/7f3789a88a01465cca30efe3b3d261bf89a100df))
+- **lookup:** re-enable schema suggestions on namespace ([56ee6c4](https://github.com/dendronhq/dendron/commit/56ee6c460dd562200931381923e72971681d1390))
+- **workbench:** reload index will update tree view ([deadedc](https://github.com/dendronhq/dendron/commit/deadedc30358ee668806434196ddd45b74aff0cc))
+- **lookup:** display schema id if title undefined ([6c7cc70](https://github.com/dendronhq/dendron/commit/6c7cc70cf85181b11654074e17672e39a44fb874))
+- **seeds:** update replace merge strategy to really replace ([a02e08a](https://github.com/dendronhq/dendron/commit/a02e08a753c0603871a1ff76e6de78906a04b056))
+## 0.12.11
+### Features
+#### Recursive Note References
+((ref:[[dendron.topic.refs]]#recursive reference,1))
+### Bug Fixes
+- **time decorator lose position**: updating the frontmatter will cause the time decorator to sometimes lose its position
+- **time decorator not updating**: turned off temporarily to investigate performance impact
+- **rename note**: doesn't update all links in some cases
+### Other
+- we've created a **bug catcher** role for folks that reported bugs to Dendron. currently trying to backfill with all the people that have contributed bugs. feel free to ping me if I missed you and big thanks to the current bug catchers!
+## [0.12.10](https://github.com/dendronhq/dendron/compare/v0.12.10-alpha.4...v0.12.10) (2020-10-16)
+### Features
+#### Rename and Refactor Commands an Order of Magnitude Faster Now (server mode) 🚀🚀🚀
+These commands have been completely re-written and use a proper markdown parser to find links (vs many fragile regex statements).
+The re-write results in both much faster performance as well as a more correct implementation.
+### Enhancements
+- **progress indicator on startup (server mode)**: loading indicator to help with large workspaces
+- **rename command support (server mode)**: rename command is now available in server mode
+- **refactor command support (server mode)**: refactor hierarchy command is now available in server mode
+- **publish notes support (server mode)**: publish notes command is now available in server mode
+- **archive command support (server mode)**: archive hierarchy is now available in server mode
+- **doctor command support (server mode)**: doctor command is now available in server mode
+### Bug Fixes
+- **schema templates not working (server mode)**: issue where schema templates were not being applied
+## [0.12.9](https://github.com/dendronhq/dendron/compare/v0.12.9-alpha.1...v0.12.9) (2020-10-15)
+### Features
+#### Human Friendly Timestamps (server mode)
+Timestamps now have human friendly decorators on the side.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/daily.ts.jpg)
+### Enhancements
+- **copyAssets configuration**: when publishing, you can now toggle whether you want to copy assets or not
+- **dump state**: dendron now has a `Dump State` command which will dump the internal state into the logs (useful for debugging)
+### Bug Fixes
+- **assets not being copied:** assets not copied on publishing when `assetsPrefix` was set
+- **GoUp comman go to wrong note (server mode):** GoUp would sometimes try to open a stub node which would result in an error
+- **Multiple workspaces result in bad timestamps (server mode):** Having multiple workspaces of the same vaults open could result in bad timestamps
+### Documentation
+((ref:[[dendron.guides.troubleshooting]]#error upgrading:#*))
+## [0.12.8](https://github.com/dendronhq/dendron/compare/v0.12.8-alpha.2...v0.12.8) (2020-10-14)
+### Features
+#### Really update time in frontmatter (server only)
+Dendron notes have frontmatter with an **updated** field. This field is supposed to show you the time in milliseconds of when the document was last updated. Until today's update, this field did not actually change  😅
+```
+id: 65b03213-d3d1-46c0-9881-a6280ed9bdeb
+title: New
+desc: ''
+updated: 1602096212957
+created: 1602096212957
+```
+Today's update makes **updated** update!
+### Enhancements
+- **support BuildPod command (server mode)**: build pod now works when server mode is enabled
+### Bug Fixes
+- **navigating to special notes**: scratch/journal notes could fail to open if note already exists
+### Other
+((ref:[[dendron.topic.extensions]]#useful extensions))
+((ref:[[dendron.guides.tips]]#copy and paste web content into dendron:#*))
+((ref:[[dendron.guides.cook]]#mobile support:#*))
+## [0.12.7](https://github.com/dendronhq/dendron/compare/v0.12.7-alpha.10...v0.12.7) (2020-10-13)
+### Features
+#### (Local) Server Side Indexing
+Dendron can now index and manage your notes as a standalone **local** server independent from VSCode.
+This is part of the [[server migration milestone|dendron.roadmap.project.n.2020.server-migration]] which we took on for October.
+Dendron's server side indexing is a **complete rewrite** of the [[Dendron engine|dendron.dev.design.engine]] which powers Dendron's lookup capabilities. The new engine is **leaner, meaner, and significantly faster** (especially when initializing your workspace with a large amount of notes).
+Server site indexing is a pre-cursor enables our upcoming roadmap items which include:
+- [[multi-vault support|dendron.roadmap.project.n.2020.multi-vault]]
+- rich graphical interfaces for schemas, pods, and publishing
+- unified index for all dendron extensions (currently each extension makes a separate index of your notes and requires manual reloading)
+- realtime updates for graph extensions
+- custom dendron extensions written in any language
+Server side indexing is currently off by default since it's still a beta feature. You can turn it on by adding the following in your settings.
+```json
+"dendron.useExperimentalLSPSupport": true
+```
+Note that the current commands are currently un-available when you switch on on server side indexing:
+- RenameNote
+- Refactor Hierarchy
+- Archive Hierarchy
+- Realtime Schema Updates
+- Pod Commands
+You can switch back to regular indexing at anytime by changing the above setting to `false` and running `> Developer: Reload Window`.
+### Enhancements
+- **Additional Arguments for lookup**: You can now use `noConfirm` and `value` arguments when creating custom lookup shortcuts ([docs](https://dendron.so/notes/a7c3a810-28c8-4b47-96a6-8156b1524af3.html#passing-arguments-to-lookup))
+- **Update Default Snippets**: default todo snippet now leaves a space after insertion
+- **Set custom log levels**: you can now define the verbosity of dendron logs using the `dendron.logLevel` configuration
+- **Upgraded Schema defaults** (server only): new schemas will be created using version one defaults
+- **Cleaner note frontmatter** (server only): new notes won't have the optional attributes in frontmatter
+### Bug Fixes
+- **Missing logs**: issue where `Open Logs` would not show logs
+- **Tree View empty**: tree view would not populate in some cases
+- **Upgrade Snippets with comments**: Upgrading settings would fail if they had comments inside the JSON
+### Breaking Changes
+- **Remove Scratch Note Command**: replaced by Lookup Scratch Note shortcut
+- **Remove Journal Note Command**: replaced by Lookup Journal Note shortcut
+### Progress
+#### Server Migration
+These past two weeks have been spent on server migration work. We are almost at the end and I'm aiming to have full coverage of all existing functionality by early next week.
+((ref:[[dendron.roadmap.project.n.2020.server-migration]]#tasks,1:#*))
+### Other
+- Add overview of [[configuration|dendron.topic.config]]
+- Add proposal for [[custom color tabs|dendron.roadmap.project.n.backlog.color-tabs]]
+## [0.12.6](https://github.com/dendronhq/dendron/compare/v0.12.5...v0.12.6) (2020-10-07)
+### Features
+#### Default Snippets
+Dendron now initializes your workspace with common default snippets
+((ref:[[dendron.topic.snippets]]#default snippets,1:#*))
+#### Latex Support on Published Site
+((ref:[[dendron.pro.dendron-jekyll.topic.math]]#math,1:#*))
+#### Introduce siteRepoDir Customization
+((ref:[[dendron.topic.publishing.configuration]]#siterepodir,1:#*))
+### Bug Fixes
+- trying to publish the `dendron-template` no longer results in a missing links report
+- issue with schemas not showing up under lookup
+### Progress
+This section tracks our progress against the milestones in our [[public roadmap|dendron.roadmap]]
+- [x] [[Seeds v0|dendron.roadmap.project.n.2020.seeds]]
+- [ ] Server migration, progress: 70/100
+  ```
+  - below is a summary of our progress. we are currently about half way done
+  - aiming to have a workable version using the Dendron server by next week
+  ```
+  ((ref:[[dendron.roadmap.project.n.2020.server-migration]]#tasks,1:#*))
+### Other
+#### Seeds
+- We launched two [[seeds|dendron.topic.seeds]]. A seed is a dendron site that tries to be be a all encompassing reference for a particular vertical. Dendron provides specific libraries and CLIs that make it easy for users to create seeds from existing open source content as well as personal notes.
+Current Seeds:
+```
+- open PKM catalogue
+- open AWS catalogue
+```
+((ref:[[dendron.community.showcase]]#open pkm catalogue,1:#*))
+((ref:[[dendron.community.showcase]]#open aws catalogue,1:#*))
+#### Alternatives
+this announcement also comes with an ask. Dendron is now in [AlternativesTo](https://alternativeto.net/), a crowdsourced catalogue for software recommendations. If you like Dendron and want to help us spread the word 🌱, please leave us a review [here](https://alternativeto.net/software/dendron/reviews/) 🙏
+## [0.12.4](https://github.com/dendronhq/dendron/compare/v0.12.4-alpha.11...v0.12.4) (2020-09-30)
+### Features
+#### Live schema updates
+- schema changes are now updated in realtime. no more `Reload Index`
+- NOTE: this doesn't yet apply to `Show Schema Graph`. you'll still need to run `Reload Index` to see the changes in the graph
+### Enhancements
+- **lookup:** special notes are now created via lookup ([da825a9](https://github.com/dendronhq/dendron/commit/da825a9d2b1ec10a3f9d3eac20db06448fe5344b))
+  - instead of being a separate command, journal and scratch notes are now created using the regular lookup interface
+  - new keybindings have been introduced to [map old commands to new style lookups](https://dendron.so/notes/a7c3a810-28c8-4b47-96a6-8156b1524af3.html#passing-arguments-to-lookup)
+  - `Create Journal Note` and `Create Scratch Note` still exist as commands but will be deprecated in the next minor release
+- **lookup:** support lookups opening with a new split ([da825a9](https://github.com/dendronhq/dendron/commit/da825a9d2b1ec10a3f9d3eac20db06448fe5344b))
+((ref:[[dendron.topic.lookup]]#split toggle))
+- **refs:** easier note ref selection([114ff87](https://github.com/dendronhq/dendron/commit/114ff87be04f8d746b0be28f7627ba0d1ec9b504))
+Dendron will now recognize a header selection if you have any part of the header highlighted (vs needing to highlight the entire line)
+((ref:[[dendron.topic.commands]]#copy note ref:#*))
+### Documentation
+- we published our public roadmap
+((ref:[[dendron.roadmap]]))
+- changelog moved to dedicated [page](https://dendron.so/notes/9bc92432-a24c-492b-b831-4d5378c1692b.html)
+- lookup menu docs
+  ((ref:[[dendron.topic.lookup]]#lookup menu:#*))
+### Community Highlights
+- a new planter has appeared 🌲
+  ((ref:[[dendron.community.showcase]]#luke's second brain))
+## [0.12.3](https://github.com/dendronhq/dendron/compare/v0.12.3-alpha.16...v0.12.3) (2020-09-26)
+### Features
+#### Bad Link Reports
+When building your site by running `Dendron: Build Pod`, Dendron will generate a bad links report of all wiki-links that did not resolve. It will also update the links to point to a 404 page instead.
+<a href="https://www.loom.com/share/91c4d7b023754b76b4d02519946603e0">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/91c4d7b023754b76b4d02519946603e0-with-play.gif"> </a>
+### Enhancements
+- **lookup:** lookup command accept args ([3e1fe8a](https://github.com/dendronhq/dendron/commit/3e1fe8a33344c3e79c1fb5bd758eaeab23b7fb9f))
+- **publishing:** better 404 page ([e74c4a2](https://github.com/dendronhq/dendron/commit/e74c4a2c97197f5d43132be6ac9436ac91d9db8a))
+- **plugin:** dramatically reduce extension bundle size ([22cfff8](https://github.com/dendronhq/dendron/commit/22cfff8398611f54f7a88d7e110aa9f9f602ad4e))
+## [0.12.2](https://github.com/dendronhq/dendron/compare/v0.12.2-alpha.0...v0.12.2) (2020-09-24)
+### Enhancements
+- **refs:** support partial header selection ([6e35393](https://github.com/dendronhq/dendron/commit/6e35393fe2d321b8d708fe1efd40c1eb4ad304e3))
+### Bug Fixes
+- **publishing:** incremental builds not setting correct links ([e3dedf5](https://github.com/dendronhq/dendron/commit/e3dedf52d79dede98041edc77a41966cc5d6e8b5))
+## [0.12.1](https://github.com/dendronhq/dendron/compare/v0.12.1-alpha.2...v0.12.1) (2020-09-22)
+### Features
+#### Create scratch or journal notes via lookup
+A journal note is a self contained note that is meant to track something over time. Examples of journals include recording **workout sessions**, making **meeting notes**, and keeping a **mood journal**.
+To create a journal note, trigger a lookup and then click on the calendar icon.
+<a href="https://www.loom.com/share/3c3ddc1dc63547cea8bf186bec31f71b">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/3c3ddc1dc63547cea8bf186bec31f71b-with-play.gif"> </a>
+A scratch note is a self contained note that is meant to be used as scratchpad. Use it for thoughts or when you want to expand on a bullet point. Scratch notes are created in the `scratch` domain and have the following format: `{domain}.journal.{Y-MM-DD-HHHHmmss}`.
+<a href="https://www.loom.com/share/2fd3042119124df8bb4592d8ffe6d708">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/2fd3042119124df8bb4592d8ffe6d708-with-play.gif"> </a>
+- **lookup:** support selection modifiers when creating special notes ([591c55f](https://github.com/dendronhq/dendron/commit/591c55f792ad8121d27af3a1c645ff9a2458f19c))
+### Enhancements
+- **lookup:** support selection and note toggles ([70cf9eb](https://github.com/dendronhq/dendron/commit/70cf9ebc7a02cc5f256c2a1ffeec62f1bf1642b8))
+- **refs:** better header selection ([ba9a4d9](https://github.com/dendronhq/dendron/commit/ba9a4d975b115e4cf8bc211f5e00f0557f26693b))
+- **refs:** emit error when header not found ([5deb2d1](https://github.com/dendronhq/dendron/commit/5deb2d18160974bd035b3703715acc16d0dcb012))
+- **publish:** configure repoDir via config ([fa838e4](https://github.com/dendronhq/dendron/commit/fa838e48bc5e33b8aa00d5aa954283c55af4d917))

Added: vault/dendron.release.changelog.1x.md

Files changed (1) hide show

vault/dendron.release.changelog.1x.md +8 -0

vault/dendron.release.changelog.1x.md ADDED Viewed

@@ -0,0 +1,8 @@
+---
+id: b7b8292e-18d2-4f28-91bf-036da5699b13
+title: -01.x
+desc: ''
+updated: 1610397084793
+created: 1610397084793
+---

Added: vault/dendron.release.changelog.early-seed.md

Files changed (1) hide show

vault/dendron.release.changelog.early-seed.md +41 -0

vault/dendron.release.changelog.early-seed.md ADDED Viewed

@@ -0,0 +1,41 @@
+---
+id: 3abd00eb-1c1e-4253-aaf5-dcbe20c21850
+title: Early Seed
+desc: ''
+updated: 1614313385678
+created: 1604539200840
+published: true
+nav_exclude: true
+---
+## 0.30.1
+### Features
+#### Custom Pods
+We now have custom pod support
+![[dendron.topic.pod.custom#summary,1:#*]]
+If you are interested in developing your own publishing pod, you can docs to do so [[here|dendron.topic.pod.dev]]
+#### Dev.to Pod
+As an example of what you can do with a custom pod, we created the [[Dev.to Pod|dendron.pro.devto-pod]] which lets you publish your notes to dev.to
+### Enhancements
+- backlinks in published sites
+![[dendron.topic.publishing.features#backlinks,1]]
+### Bug Fixes
+- delete node sometimes fails in multi-vault
+- publishing multi-vault will sometimes not work if multiple domain notes
+- unable to select `root` of multi-vault notes in tree view
+### House Cleaning
+- if you're working on the codebase, `dendron.code-workspace` has been renamed to `dendron-main.code-workspace`
+  - this helps if you're working on dendron while having dendron installed since Dendron, prior to this change, would also activate when you were editing the code

Added: vault/dendron.release.changelog.md

Files changed (1) hide show

vault/dendron.release.changelog.md +606 -0

vault/dendron.release.changelog.md ADDED Viewed

@@ -0,0 +1,606 @@
+---
+id: 9bc92432-a24c-492b-b831-4d5378c1692b
+title: Changelog
+desc: ''
+updated: 1615242074818
+created: 1601508213606
+date: '2022-01-01'
+---
+## 0.31.3
+### Features
+#### Changelogs
+![[dendron.topic.publishing.changelogs#summary,1:#*]]
+### House Cleaning
+- all tests are now `jest style` tests
+## 0.31.2
+### Features
+#### Custom Domain Names
+Dendron now supports custom domain names for [[managed publishing|dendron.topic.managed-publishing]]. You can find docs [[here|dendron.topic.managed-publishing.quickstart#adding-a-custom-domain-via-cname]]. Note that this feature is currently limited to [[environmentalist|dendron.community.roles#environmentalist]] .
+### Enhancements
+- Add paste link command ([[docs|dendron.topic.commands#paste-link]])
+- don't throw fatal error on bad wikilink
+- don't throw fatal error if `siteUrl` not set while in `dev`
+- add remark-containers plugin [[docs|dendron.topic.config#usecontainers]]
+### Bug Fixes
+- refs don't include children or backlinks
+- clean `dendron.yml` after removing a vault
+## 0.31.1
+### Bug Fixes
+- issue with mixed case file names
+## 0.31.0
+***
+## 0.30.2
+### Features
+#### Cross Vault Links
+![[dendron://dendron-site/dendron.topic.links#cross-vault-links,1]]
+### Enhancements
+- you can now add a workspace when adding a remote vault ([[docs|dendron://dendron-site/dendron.topic.commands#vault-add]])
+- better block quotes ([[docs|dendron.topic.publishing.misc#blockquote]])
+- better formatted backlinks on published pages
+- backlinks display using note title instead of file names
+- copy note commands will create a cross vault link when in multi-vault environment
+### Bug Fixes
+- selecting non-primary root note in dendron tree
+- bad backlinks created for home page
+- issue with hierarchies for mixed case parents
+### Documentation
+- new docs on using dendron for [[blogging|dendron.topic.publishing.blogging]]
+### House Cleaning
+- table of contents on published sites is now a remark extension, header changed to `children`
+- jekyll publishing has been renamed to `legacy publishing`
+- lots of internal refactoring of code
+## 0.30.1
+### Features
+#### Custom Pods
+We now have custom pod support
+![[dendron.topic.pod.custom#summary,1:#*]]
+If you are interested in developing your own publishing pod, you can docs to do so [[here|dendron.topic.pod.dev]]
+#### Dev.to Pod
+As an example of what you can do with a custom pod, we created the [[Dev.to Pod|dendron.pro.devto-pod]] which lets you publish your notes to dev.to
+### Enhancements
+- backlinks in published sites
+![[dendron.topic.publishing.features#backlinks,1]]
+### Bug Fixes
+- delete node sometimes fails in multi-vault
+- publishing multi-vault will sometimes not work if multiple domain notes
+- unable to select `root` of multi-vault notes in tree view
+### House Cleaning
+- if you're working on the codebase, `dendron.code-workspace` has been renamed to `dendron-main.code-workspace`
+  - this helps if you're working on dendron while having dendron installed since Dendron, prior to this change, would also activate when you were editing the code
+## 0.29.2
+### Features
+#### Experimental Nunjuck Templates
+Extremely powerful templating capabilities with [[nunjuck templates|dendron.topic.markdown#nunjuck-templates]]
+### Enhancements
+- better multi-vault defaults
+  - instead of keeping [[remote vaults|dendron.concepts#remote-vault]] under a special `repos` folder, you can now initialize them where ever you want
+- better git defaults with new vaults
+### Bug Fixes
+- support turning off pretty refs for dendron preview ([[docs|dendron.topic.config#useprettyrefs]])
+## 0.29.1
+### Enhancements
+- private vaults ([[docs|dendron.topic.config#visibility]])
+- popover 403 links ([[docs|dendron.topic.publishing.selective-publication#403-page]])
+- standardize pod cli interface
+### Bug Fixes
+- use builtin clipboard manager
+- private wiki links render errors on published page
+### House Cleaning
+- [issue labeling automation](https://github.com/dendronhq/dendron/pull/453)
+- remove legacy publishing commands (BuildPod & Publish)
+## 0.28.1
+### Features
+#### Managed Publishing (Early Preview)
+The initial release comes with the ability to publish a dendron workspace under {username}.dendron.wiki.
+Dendron takes care of configuring your domain and building your site.
+After you connect your github repo with Dendron, we'll kick off the initial publication.
+Every subsequent time you push to your repo, Dendron will automatically build your site with the latest changes.
+At launch, we are supporting publishing from a connected github repo.
+Instructions to get started are [[here|dendron.topic.managed-publishing.quickstart]]
+### Enhancements
+- show last modified time for published sites ([[docs|dendron.topic.publishing.configuration#sitelastmodified-optional]])
+- add option to configure human readable ts formatting  ([[docs|dendron.topic.config#dendrondefaulttimestampdecorationformat]])
+- smaller downloads when using publishing commands for the first time
+- much faster publishing commands
+- frontmatter can now be folded
+### Bug Fixes
+- 11ty build issues
+- dendron `move note` command can fail when parents are stubs
+- preview can get out of sync with Dendron
+### House Cleaning
+- dendron monorepo is now on yarn
+  - this results in 4x faster initial builds and 6x smaller bundle sizes when developing
+- dendron-11ty is now merged into the dendron monorepo
+If you currently have Dendron checked out, you can use the following instructions to migrate
+```sh
+# get latest version
+git pull
+npm install -g yarn
+# remove old node_modules
+./bootstrap/scripts/cleanup.sh
+yarn bootstrap:bootstrap
+yarn bootstrap:build
+```
+## 0.27.2
+### Features
+- diagnostics report ([[docs|dendron.topic.commands#dendrondev-diagnostics-report]])
+![[dendron.topic.commands#dendrondev-diagnostics-report,1]]
+### Enhancements
+- add path customization to build-site ([[docs|dendron.topic.cli#buildsitev2]])
+- Add default description option to dendron config  ([[docs|dendron.topic.publishing.configuration#description]])
+- add config to publish multi-vault when adding vault ([[docs|dendron.topic.publishing.configuration#duplicatenotebehavior-optional]])
+### Bug Fixes
+- build-site doesn't overwrite STAGE environment
+- do not delete text when extracting non-vault text
+- add new vaults to newline in .gitignore
+## 0.27.1
+### Bug Fixes
+- server close error when building website for production
+## 0.26.1
+### Features
+- move notes between vaults using the move note command ([[docs|dendron.topic.commands#move-note]])
+### Enhancements
+- nicer 403 page on unpublished pages ([[docs|dendron.topic.publishing.selective-publication#403-page]])
+### Bug Fixes
+- issue with daily journal notes not getting pretty titles
+- ctrl hover over images will create a note
+- when removing a note with empty parents, clean up empty parents
+## 0.25.3
+### Features
+- mermaid diagram support when publishing ([[docs|dendron.topic.markdown#diagrams]])
+- display note title as link ([[docs|dendron.topic.config#usenotetitleforlink]])
+### Enhancements
+- use list of vaults when resolving duplicate notes ([[docs|dendron.topic.publishing.configuration#passing-multiple-vaults]])
+- go to definition now works for `![[refs]]`
+- [[Copy Note Link|dendron.topic.commands#copy-note-link]] now updates alias to header value when copying header
+### Bug Fix
+- grammar issue with unpublished page notification
+### House Cleaning
+- remove `sync_vault` as a step when building dendron for the first time
+## 0.25.2
+### Bug Fix
+- issue with new vaults not having welcome note
+## 0.25.1
+### Bug Fix
+- issue with md outline not showing
+## 0.24.2
+### Features
+#### Site Build and Preview built-in to extension
+You can now publish and build your notes without going to the command line ([[docs|dendron.topic.commands#site-build]])
+### Enhancements
+- show progress bar when syncing graph
+- show progress bar when installing node modules
+- [[useFMTitle|dendron.topic.config#usefmtitle]] set to true by default
+- add `.gitignore` to newly created workspace
+- [[Copy Note Url|dendron.topic.commands#copy-note-url]] uses `siteUrl` as value for noteRef
+### Bug Fixes
+- fix issues with nav capitalization
+- fix dup items in nav
+- windows site preview not cleaning up child processes
+- fix note graph errors
+### Docs
+- revamped publishing docs
+### House Cleaning
+- jekyll based publishing is now deprecated
+- [[dendron.copyNoteUrlRoot|dendron.topic.config#dendroncopynoteurlroot]] deprecated for `siteUrl`
+## 0.24.1
+### Features
+### Enhancements
+- enable pass dict to config ([ccbc017](https://github.com/dendronhq/dendron/commit/ccbc0178cdc0399230a47e4ab1c90d345e447aeb))
+- use enhanced filter when creating 403 links ([65afe8c](https://github.com/dendronhq/dendron/commit/65afe8c084d1a657e943edb3ef1b497f3fd97ea6))
+- custom header support ([[docs|dendron.topic.publishing.configuration#customheaderpath-optional]])
+  - [[add custom headers|scratch.2021.01.12.085012.add-custom-headers]]
+- google analytics support ([[docs|dendron.topic.publishing.configuration#ga_tracking-optional]])
+- [[Multi Vault Edit on GitHub|dendron.scratch.2021.01.09.multi-vault-edit-on-github]]
+### Bug Fixes
+- fix multi-vault breadcrump null issue
+- fix windows build for site
+## 0.23.2
+### Features
+### Enhancements
+- better 403 page ([[docs|dendron.topic.publishing.selective-publication#403-page]])
+- spurious error message if user doesn't create note from not selecting a vault
+- better default journal note titles
+### Bug Fixes
+- issue publishing with subdomain
+- some queries not being returned in multi-vault settings
+- issue with noteRef mangling when using doctor
+### House Cleaning
+- update on date format for journal and scratch notes to use [Luxon style formatting](https://moment.github.io/luxon/docs/manual/formatting.html)
+## 0.23.1
+- Dendron Markdown Preview: 0.10.18
+- Dendron 11ty: 1.23.6
+### Features
+#### Updated Note Ref Syntax
+You can now do references to notes using `![[note]]` instead of `((ref: [[note]]))` syntax. To reference a header, use `![[note#foo]]`. This changes makes our note ref syntax more consistent with our wiki link syntax.
+Note that the new ref syntax expects a [[sluggified|dendron.ref.terms#slug]] header. This is done automatically when you use the updated [[copy note ref|dendron.topic.commands#copy-note-ref]] command.
+This change makes it possible to create a ref to a header with special characters.
+The old syntax ref syntax will still work but should now be considered deprecated. We will release a `doctor` command to help you auto-upgrade from the old syntax to the new syntax in the coming week.
+#### Frontmatter Variable Substitution
+It is now possible to use variables defined in your note frontmatter inside your note. The syntax is `{{fm.VAR_NAME}}` where `VAR_NAME` is the name of your variable. The `fm` designates that you want to use a frontmatter variable.
+<!--
+#### Publishing V2 Integration with Plugin
+You can now both build your notes for publication and preview it from inside vscode.
+![[dendron.topic.commands#site-build:#dev]]
+-->
+### Enhancements
+- `nav_exclude` property excludes from nav sider and table of contents ([[docs|dendron.topic.publishing.navigation#nav-exclude]])
+- [[copy note ref|dendron.topic.commands#copy-note-ref]] command will use the new note ref syntax
+- footnote support in preview and when publishing ([[docs|dendron.topic.markdown#footnotes]])
+### Bug Fixes
+- spaces in wiki link not rendering in preview
+## 0.22.2
+### Enhancements
+- better fuzzy search for lookup
+- publishing v2 enhancements
+  - abbreviation support for 11ty publishing ([[docs|dendron.topic.markdown#abbreviation]])
+  - better note titles ([[docs|dendron.ref.titles]])
+  - shrink size of published page 10x
+  - fix left nav position of current active page
+  - ability to override output folder from CLI when building site
+  - don't throw error on code blocks that are unsupported by prismjs
+### Bug Fixes
+- markdown preview delay in showing newly created notes
+- `buildSiteV2` not connect to running workspace
+## 0.22.1
+### Features
+- [[Collections|dendron.topic.publishing.collections]] support for 11ty
+  - publish blog like archives using Dendron
+- CLI Based Doctor ([[docs|dendron.topic.cli#doctor]])
+  - run various tests to make your notes are healthy for the new year
+- use frontmatter as title when publishing and in the preview ([[docs|dendron.topic.config#usefmtitle]])
+### Enhancements
+- additional metadata tags for published pages
+- support `noindex` option ([[docs|dendron.topic.publishing.configuration#noindex]])
+- add anchor links to headers
+- use note title for page title
+- support [[nav_exclude|dendron.topic.publishing.configuration#nav_exclude]] option
+- support overriding [[output|dendron.topic.cli#buildsitev2]] in `buildSiteV2` command
+- don't throw error if no syntax highlighter available for code block
+### Bug Fixes
+- issue connecting to open workspace using CLI
+- nav bar when publishing multiple hierarchies will show wrong expansion options
+## 0.21.2
+### Enhancements
+- build-site command can connect to current running workspace ([[docs|dendron.topic.cli#connect-to-open-workspace]])
+- support inline math when publishing
+- support block math when publishing
+- support rendering gfm inside note reference when publishing
+- support anchor headings when publishing
+- support relative links when publishing
+### Bug Fixes
+- issue with displaying math in preview
+### House Cleaning
+- the code highlighter has been changed from `prismjs` to `highligher.js`
+## 0.21.1
+### Enhancements
+- add seo tags ([[docs|dendron.topic.publishing.configuration#seo-options]])
+- enable edit on github link ([[docs|dendron.topic.publishing.configuration#github-options]])
+- migrate all jekyll `_config.yml` settings to `dendron.yml`
+### Bug Fixes
+- build-site errors when building from vaults without `asset folder`
+- build-site error on certain operating systems
+- build-site error on node version != 12
+### Docs
+- [dendron.so](https://dendron.so) is now published using the new 11ty framework
+- add [[publishing to github guide|dendron.topic.publishing.github]] using github actions
+## 0.20.2
+### Features
+#### Publishing For Multi Vault
+![[dendron.topic.multi-vault#publishing:#*]]
+### Enhancements
+- creating engine via cli also initializes meta files ([d72f097](https://github.com/dendronhq/dendron/commit/d72f097e63d1fda065ac7ad50f85bebe99d6da66))([[docs|dendron.topic.cli#launchengineserver]])
+- remove github light theme from dendron bundle ([33d5708](https://github.com/dendronhq/dendron/commit/33d57086510cdaefbb8af8f72c945d6f5e02be5c))
+- support [[note refs for multi-vault|dendron.topic.multi-vault#note-references]]
+- support relative links in dendron preview ([[docs|dendron.topic.links#wiki-links]])
+- further speed enhancements to publishing using 11ty resulting in another 5x improvement
+- configure [[writeStubs|dendron.topic.publishing.configuration#writestubs-optional]] from `dendron.yml`
+### Bug Fixes
+- refactor hierarchy miss self referential links ([00b385d](https://github.com/dendronhq/dendron/commit/00b385dd0d13e5809da012bbc88388886012b837))
+- reduce frequency of `engine not connecting` error when launching dendron preview
+### House Cleaning
+- [[writeStubs|dendron.topic.publishing.configuration#writestubs-optional]] is set to `true` by default (or when not set) when publishing using 11ty
+## 0.20.1
+### Publishing V2 (preview)
+We've re-build publishing for Dendron from the ground up to be faster, better, and easier to use.
+Besides for schemas, publishing has consistently been one of the hardest to use features in Dendron. Dendron currently publishes using [jekyll](https://jekyllrb.com/) using our own [template](https://github.com/dendronhq/dendron-jekyll). While this has served as well initially, slow compile times for large sites and difficulty of getting started has made it a growing pain point.
+To address this, we've migrated our publishing stack to [11ty](https://www.11ty.dev/), a super fast javascript based static generator. This means much faster, and perhaps more importantly, easier publishing.
+There's still some work left to integrate publishing into the Dendron plugin - meanwhile, you can take the new publishing workflow for a spin using the [[dendron cli|dendron.topic.cli]]
+In order to to use the 11ty based publishing, initialize your workspace with the following commands.
+```bash
+npm init -y
+npm install @dendronhq/dendron-cli@latest
+npm install @dendronhq/dendron-11ty@latest
+```
+After you have your dependencies installed, build your your site using the following command.
+```bash
+npx dendron-cli buildSiteV2 --wsRoot .  --stage dev --serve
+```
+This will both compile your site locally and make it available at `localhost:8080` for instant preview. When building your site locally, the pages will be build to `{wsRoot}/build/site`.
+When you are ready to publish to github, make sure to change the stage to `prod`.
+```bash
+npx dendron-cli buildSiteV2 --wsRoot .  --stage prod
+```
+This will build your site to the path specified by [[siteRootDir|dendron.topic.publishing-legacy.configuration#siterootdir]] in `dendron.yml`.
+#### Benchmarks
+Publishing V2 is ~10x faster than jekyll based publishing for sites with +100 pages. For comparison, below is the compilation difference between building the dendron site using 11ty vs jekyll.
+- 11ty: 24.45s
+- jekyll: 220.33s
+There are additional optimizations still on the table that will further drive down he compilation time by another order of magnitude for future releases.
+#### Gaps
+11ty publishing is currently not at full feature parity with Jekyll publishing. Notably, the following features are missing:
+- setting a custom color theme
+- `edit on github` links
+- `jekyll-seo` functionality
+- mathjax
+#### Migration
+All values that used to be written into `_config.yml` will now be moved into `dendron.yml`. You can see the currently supported configuration values here: `https://github.com/dendronhq/dendron/blob/master/packages/common-all/src/types.ts#L71:L71`
+If you currently have a Jekyll based Dendron page, note that the following settings have changed:
+- the `url` property from `_config.yml` is now `siteUrl` in `dendron.yml`
+- favicon is now controlled by `siteFaviconPath` in `dendron.yml` and is a path relative to your workspace root
+- `CNAME` is now controlled by `githubCname` property in `dendron.yml`
+#### Sample dendron.yml config
+- publishing without a cname
+```yml
+version: 1
+vaults:
+    - fsPath: vault
+site:
+    copyAssets: true
+    siteHierarchies:
+        - dendron
+    siteRootDir: docs
+    siteUrl: "kevinslin.github.io/dendron-11ty-test"
+    usePrettyRefs: true
+```
+- using custom cname
+```yml
+version: 1
+vaults:
+    - fsPath: vault
+site:
+    copyAssets: true
+    siteHierarchies:
+        - dendron
+    siteRootDir: docs
+    usePrettyRefs: true
+    siteUrl: "11ty.dendron.so"
+    githubCname: "11ty.dendron.so"
+```
+#### Sample repo
+- [github repo](https://github.com/kevinslin/dendron-11ty-test/deployments/activity_log?environment=github-pages)
+- [github page](https://kevinslin.github.io/dendron-11ty-test/)
+#### CLI Command Reference
+```bash
+dendron-cli buildSiteV2
+build notes for publication using 11ty
+Options:
+  --version  Show version number                                       [boolean]
+  --help     Show help                                                 [boolean]
+  --wsRoot   location of workspace                                    [required]
+  --vaults   location of vault                                           [array]
+  --serve    serve over local http server             [boolean] [default: false]
+  --stage    serve over local http server
+```
+<!-- https://hacks.mozilla.org/2020/10/to-eleventy-and-beyond/ -->
+## Past Releases
+- [[0.1.X|dendron.release.changelog.0-1-x]]

Added: vault/dendron.release.md

Files changed (1) hide show

vault/dendron.release.md +15 -0

vault/dendron.release.md ADDED Viewed

@@ -0,0 +1,15 @@
+---
+id: 932534e7-e788-4fdb-bc8c-eaf761992a8d
+title: Releases
+desc: ''
+updated: 1610062266206
+created: 1595984607503
+stub: false
+nav_order: 8
+has_collection: true
+sort_by: date
+sort_order: reverse
+expand_exclude: true
+---

Added: vault/dendron.rfc.1-dendron-nextjs.md

Files changed (1) hide show

vault/dendron.rfc.1-dendron-nextjs.md +55 -0

vault/dendron.rfc.1-dendron-nextjs.md ADDED Viewed

@@ -0,0 +1,55 @@
+---
+id: 17c61d62-f92e-4002-b8fe-9c05686e4bf9
+title: "1 Dendron: Next Edition"
+desc: ''
+updated: 1615160650280
+created: 1610911846754
+---
+## Why
+- remove Markdown Preview Enhanced (MPE) dependency
+    - MPE has a huge surface area and we only use a small part of its feature set
+    - MPE is a sizable download (40mb) with performance issues on startup and a few other cases
+    - MPE is based on `markdown-it` whereas dendron is based on `remarkable`
+        - this makes our features sets incompatible and makes a lot of the MPE code base unsuitable for extension
+        - this also causes notes in the preview to render differently from code in the browser
+- use next.js for markdown preview
+    - next.js is already used in Dendron webviews (eg. `Dendron: Configure`) and the plan is to convert all UI components to webviews
+    - next.js lets us add rich visualizations based on React and the latest web technologies
+    - next.js will let us eventually use MDX
+    - next.js can eventually be used as a scaffold for our own web client or dedicated desktop client
+## Goals with v1
+- [ ] use next.js to do local preview of dendron notes
+### Stretch Goals
+- [ ] scroll sync
+- [ ] use next.js to preview dendron site
+- [ ] better preview for schemas
+### Additional Features
+- [ ] folding of headers
+## Future Goals
+- use next.js to provide WYSWYG experience for dendron notes
+- incorporate native lookup inside Dendron
+## Considerations
+- we currently render notes into HTML for publication with 11ty. it seems like duplicate effort to re-create this in next.js
+    - ideally, want to either serve the static assets from 11ty using next.js or use next.js to generate the static assets
+    - kevin's thoughts: I like to be able to use next.js for everything down the line (static site generation + preview) but it might make more sense presently to implement a vscode specific preview and then figure out how to merge 11ty and next.js afterwards
+- Dendron currently uses express as a backend
+    - we generate static assets from next.js at compile time using `next export` and then serve them over express
+    - Moving forward, if we want to use next.js for preview generation, we will probably need to swap out express with next.js
+    - reason we currently have the next.js/express split is because `next dev` dynamically re-compiles each route one at a time which causes our integration tests to fail (our integration tests call on the APIs from express ) and next.js causes the initial call to fail
+    - we'll need to either find a workaround in next.js our use next.js [custom server functionality](https://nextjs.org/docs/advanced-features/custom-server) to embed express
+    - kevin's thought: use custom server functionality. we'll lose out on some next.js code splitting features but should give us the best of both worlds otherwise
+## Tasks
+- [ ] bundle next.js with dendron using custom router
+- [ ] add api to dendron engine to preview a note
+- [ ] update `Dendron: Show Preview` command to call API with current note
+## Related
+- [Code for rendering webview currently](https://github.com/dendronhq/dendron/blob/master/packages/plugin-core/src/commands/ConfigureWithUI.ts#L6:L6)

Added: vault/dendron.rfc.2-managed-publishing.md

Files changed (1) hide show

vault/dendron.rfc.2-managed-publishing.md +49 -0

vault/dendron.rfc.2-managed-publishing.md ADDED Viewed

@@ -0,0 +1,49 @@
+---
+id: ae4a0c98-e2ea-47e0-8a20-016eba3424be
+title: 2 Managed Publishing
+desc: ''
+updated: 1615160645832
+created: 1611853430165
+---
+## Goal
+Make it easy for everyone to publish a [digital garden](https://www.kevinslin.com/notes/30a9ec3e-d58f-44ce-8d7c-535f122f7d0b.html)
+## Tenants
+- publishing should be accessible to everyone
+## Product
+Provide a [netlify](https://www.netlify.com/) like service focused solely on Dendron based content.
+This service will let you selectively publish your notes using Dendron itself without having to configure a third party host like netlify or github pages.
+Pages will be hosted and published using [AWS](aws.amazon.com/) and will be [deployed globally](https://aws.amazon.com/cloudfront/features/) across the AWS edge network.
+Your published page will have its own subdomain under `{username}.dendron.wiki`. We'll add support for custom domains early February as well.
+## Features
+- [x] publish to dendron subdomain
+- [x] SSL certs
+- [x] global deployments using [worldwide CDN](https://en.wikipedia.org/wiki/Content_delivery_network)
+- [x] github based publishing
+## Upcoming Features
+- [ ] custom domain names
+- [ ] protect published notes with a username/password
+- [ ] whitelist individuals by email when sharing published notes
+- [ ] create a secure link to a page (could be published or not-published)
+- [ ] get detailed analytics for a page
+- [ ] support comments underneath the page
+- **{your suggestion here}**
+## Pricing
+- Publishing one public workspace will be free.
+- Publishing with additional features will have a nominal monthly fee with tiered pricing depending on feature set
+## FAQ
+### What if I want to publish using my own provider?
+Dendron generates static assets and you'll always be able to publish using any host that can serve static content (aka all of them). Dendron managed publishing is about giving users a simplified one click solution to selectively publish notes that is maintained to be always up to date with the latest Dendron release.

Added: vault/dendron.rfc.2-managed-publishing.ref.github-token.md

Files changed (1) hide show

vault/dendron.rfc.2-managed-publishing.ref.github-token.md +14 -0

vault/dendron.rfc.2-managed-publishing.ref.github-token.md ADDED Viewed

@@ -0,0 +1,14 @@
+---
+id: e0e854eb-ed78-4a98-8a95-5120426b7a1d
+title: GitHub Token
+desc: ''
+updated: 1613063569227
+created: 1613062854778
+---
+1. Create a new [personal access token](https://github.com/settings/tokens/new)
+2. Check the following boxes
+    ![](/assets/images/2021-02-11-09-11-49.png)
+3. Copy you access token
+    ![](/assets/images/2021-02-11-09-12-42.png)

Added: vault/dendron.rfc.2-managed-publishing.ref.md

Files changed (1) hide show

vault/dendron.rfc.2-managed-publishing.ref.md +9 -0

vault/dendron.rfc.2-managed-publishing.ref.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: 8f3f56fe-e45c-41d8-a8f0-f21f822b4877
+title: Ref
+desc: ''
+updated: 1613444021667
+created: 1613444021668
+stub: true
+---

Added: vault/dendron.rfc.4-link-templates.md

Files changed (1) hide show

vault/dendron.rfc.4-link-templates.md +71 -0

vault/dendron.rfc.4-link-templates.md ADDED Viewed

@@ -0,0 +1,71 @@
+---
+id: 7117a023-f090-47f5-a104-5968fc256c23
+title: 4 Richer Templating
+desc: ''
+updated: 1615160638029
+created: 1613929636812
+---
+## Goals
+More powerful templating features for Dendron
+## Details
+## Proposal
+Use [nunjucks](https://mozilla.github.io/nunjucks/) to customize Dendron
+### Example
+- overriding properties in a link
+```
+{{ ![[foo]] | config(prettyRef = false) }}
+```
+- rendering a note ref with a custom template
+    ```
+    {{ ![[people.john]] | template("person") }}
+    ```
+    - raw note
+    ```
+    ---
+    title: John Snow
+    homepage: https://john.dendron.wiki
+    discord: @john123
+    email: john@hey.me
+    ---
+    ```
+    - template
+    ```
+    {% block content %}
+    # [{{fm.title}}]({{fm.homepage}})
+    - discord: {{fm.discord}}
+    - email: {{fm.email}}
+    {% endblock %}
+    ```
+    - output
+    ```md
+    # [John Snow](https://john.dendron.wiki)
+    - discord: @john123
+    - email: john@hey.me
+    ```
+## Tradeoffs
+- pros
+- cons
+    - slow down compilation time
+## Related
+## People
+- [[Tmss|people.tmss]]

Added: vault/dendron.rfc.5-publishing-registry.md

Files changed (1) hide show

vault/dendron.rfc.5-publishing-registry.md +66 -0

vault/dendron.rfc.5-publishing-registry.md ADDED Viewed

@@ -0,0 +1,66 @@
+---
+id: 21b2e152-95f7-4904-8a8e-8d4d0b8c950c
+title: 5 Publishing Registry
+desc: ''
+updated: 1614550954834
+created: 1614183727211
+---
+## Goals
+Make it possible to discover, link, and build upon other published digital gardens.
+## Tenants
+- extensible
+- accessible
+- interoperable
+## Use Cases
+- link to and from other gardens with automatic reference tracking and citations
+- discovery of gardens based on topics and interests
+## Proposal
+Create both a spec and an initial implementation of the spec to keep a registry of digital gardens.
+- Metadata for Garden:
+    - url: domain
+    - updated: epoch, last updated
+    - created: epoch, created
+    - author: name of author
+    - author.email: email of author
+    - linksTo: all gardens that this one links to, updated during upload
+    - linksFrom: all gardens that link to the current page, dynamically calculated and cached
+    - schemas: list of [[Schemas|dendron.topic.schema]] adopted by the garden
+    - tags: list of tags
+    - license: license for garden
+    - host: hosting platform
+- Metadata for individual page:
+    - should be similar to that of garden
+## Example
+```
+curl ENDPOINT/gardens/{username}/{gardenName}
+url: dendron.so
+tags: [pkm, vscode, note-taking]
+updated: 1614184037
+created: 1614182037
+primaryAuthor: Kevin Lin
+linksFrom:
+- kiran/homepage
+- nikita/homepage
+- ...
+linksTo:
+- dendronhq/pkm
+host:
+  type: git
+  url: https://github.com/dendronhq/dendron-site.git
+  scope: public
+```
+## Tradeoffs
+- TBD

Added: vault/dendron.rfc.md

Files changed (1) hide show

vault/dendron.rfc.md +8 -0

vault/dendron.rfc.md ADDED Viewed

@@ -0,0 +1,8 @@
+---
+id: f143ca38-dcc6-4cd3-b84b-997aec1160ef
+title: Rfc
+desc: ''
+updated: 1610911876863
+created: 1605539111635
+---

Added: vault/dendron.roadmap.md

Files changed (1) hide show

vault/dendron.roadmap.md +44 -0

vault/dendron.roadmap.md ADDED Viewed

@@ -0,0 +1,44 @@
+---
+id: 6e4c4f61-80a3-46fa-9ad3-04b99d9e9695
+title: Project Public Roadmap
+desc: ''
+updated: 1614538364450
+created: 1600840127160
+stub: false
+nav_order: 2.1
+nav_exclude: true
+---
+The Dendron Public Roadmap is a list of all the things we're working on for the year.
+You can see the corresponding issues on [github](https://github.com/orgs/dendronhq/projects/1) where you can leave comments and feedback. You can also comment in our [#feedback](https://discord.gg/mxvczE9) channel on discord.
+# Legend
+- `[x]`: done
+- \#wip: work in progress
+- \#feedback: actively looking for feedback
+## Epics
+- September
+  - [x] [[principles and values|dendron.roadmap.project.n.2020.principles-and-values]]
+  - [ ] [[pods v0|dendron.roadmap.project.n.2020.pods]]
+  - [x] [[seeds v0|dendron.roadmap.project.n.2020.seeds]]
+- October
+  - [x] [[Server Migration|dendron.roadmap.project.n.2020.server-migration]] #wip
+  - [x] [[Quality of Life Improvements v0|dendron.roadmap.project.n.2020.qol]] #feedback #wip
+- November
+  - [ ] [[Multi Vaults|dendron.roadmap.project.n.2020.multi-vault]] #wip
+  - [ ] [[Long Term Sustainability v0|dendron.roadmap.project.n.2020.long-term-sustainability]]
+- December
+  - [ ] [[Git all the people|dendron.roadmap.project.n.2020.git]]
+  - [ ] [[Power Functionality v0|dendron.roadmap.project.n.2020.power-functionality]]
+## Long Lived Initiatives
+These projects don't have an end date. They are something we'll continuously work towards.
+- [[Better Docs|dendron.roadmap.project.n.2020.better-docs]]
+- [[Community Building|dendron.roadmap.project.n.2020.community-building]]
+- [[Recruiting Gardeners|dendron.roadmap.project.n.2020.recruit-gardeners]]

Added: vault/dendron.roadmap.project.cook.md

Files changed (1) hide show

vault/dendron.roadmap.project.cook.md +22 -0

vault/dendron.roadmap.project.cook.md ADDED Viewed

@@ -0,0 +1,22 @@
+---
+id: 3f63b02d-6385-45ad-b0b6-b797d221d714
+title: Cookbook
+desc: ''
+updated: 1599504980338
+created: 1599504980338
+stub: false
+---
+## Access Dendron Repo issues inside VSCode (optional)
+- this might require that you have vscode insiders
+- this might be useful to do even if you don't plan on working on the code since it lets you interact with github issues from inside vscode
+- [ ] checkout the [dendron repo](https://github.com/dendronhq/dendron)
+- [ ] download [GitHub Pull Requests and Issues](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) extension
+## Access Dendron Template issues inside VSCode (optional)
+- follow same instruction as above (minus downloading the extension if you already have it installed)

Added: vault/dendron.roadmap.project.md

Files changed (1) hide show

vault/dendron.roadmap.project.md +75 -0

vault/dendron.roadmap.project.md ADDED Viewed

@@ -0,0 +1,75 @@
+---
+id: 8cf880da-6402-47fb-8e9a-9d5fa38e31d0
+title: Project
+desc: ''
+updated: 1609269445117
+created: 1599498964153
+stub: false
+---
+This hierarchy describes the short term and long term projects of Dendron.
+## Q4 2020
+- [[Principles and Values|dendron.roadmap.project.n.2020.principles-and-values]]
+- [[Pods|dendron.roadmap.project.n.2020.pods]]
+- [[The Seed Bank|dendron.roadmap.project.n.2020.seeds]]
+- [[Recruit Gardeners|dendron.roadmap.project.n.2020.recruit-gardeners]]
+- [[Quality of Life Improvements|dendron.roadmap.project.n.2020.qol]]
+- [[Dendron Language Server Protocol|dendron.roadmap.project.n.2020.server-migration]]
+- [[Multi-Vault Support|dendron.roadmap.project.n.2020.multi-vault]]
+- [[Community Building|dendron.roadmap.project.n.2020.community-building]]
+- [[Power Functionality|dendron.roadmap.project.n.2020.power-functionality]]
+- [[Better Docs|dendron.roadmap.project.n.2020.better-docs]]
+- [[Git All The People|dendron.roadmap.project.n.2020.git]]
+- [[Long Term Sustainability|dendron.roadmap.project.n.2020.long-term-sustainability]]
+## Commenting and Reviews
+### For Dendrologists
+The easiest way to leave a comment is by using the [code stream extension](https://marketplace.visualstudio.com/items?itemName=CodeStream.codestream).
+You should have received an invite to be part of the **Dendrologist** team (if not, ping Kevin).
+After you install the extension and log in, you'll be able to leave comments inline in the the docs!
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/project.code-stream.gif)
+## Other Resources
+- [[Cookbook|dendron.roadmap.project.cook]]: Optional things to help you manage Dendron projects
+# Structure
+## Custom Frontmatter
+- start: start date for project
+- end: end date for project
+## Snipets
+- `project`: creates the outline for a new project
+## Sections
+```
+## Goals
+What are we trying to accomplish. Try to limit this to one or two sentences.
+## Details
+This can be used to further elaborate on the task at hand
+## Discussions
+Link to existing discussion on the topic.
+## Tasks
+What tasks are related to accomplish this project?
+## Release Notes
+What does the public announcement of this project look like?
+```

Added: vault/dendron.roadmap.project.n.2020.better-docs.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.better-docs.md +18 -0

vault/dendron.roadmap.project.n.2020.better-docs.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+id: c8690c83-dae2-4d16-849a-555a25c5a57a
+title: Better docs
+desc: ''
+updated: 1599501863528
+created: 1599501863528
+stub: false
+---
+## Goals
+Improve Dendorn documentation for new comers and power users
+## Details
+## Tasks
+## Release Notes

Added: vault/dendron.roadmap.project.n.2020.community-building.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.community-building.md +18 -0

vault/dendron.roadmap.project.n.2020.community-building.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+id: b01d9f1d-a289-412c-8e42-bbfac02ed843
+title: Community building
+desc: ''
+updated: 1599501757503
+created: 1599501757503
+stub: false
+---
+## Goals
+Grow the Dendron community while keeping the intimate and cozy atmosphere we have today
+## Details
+## Tasks
+## Release Notes

Added: vault/dendron.roadmap.project.n.2020.git.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.git.md +32 -0

vault/dendron.roadmap.project.n.2020.git.md ADDED Viewed

@@ -0,0 +1,32 @@
+---
+id: 37f3623c-d87e-4181-8531-2edb578d3391
+title: Git All the People
+desc: ''
+updated: 1599577035289
+created: 1599577035289
+stub: false
+start: 2020.12.07
+end: 2020.12.16
+status: Next
+---
+## Goals
+Git+Dendron make an ideal workflow but this is currently hard and non-obvious to get started with, especially for non-programmers. Ideally, we should be able to integrate all the benefits of git (versions, blame annotations, log history, etc) without the end user even being aware that git is being used.
+## Details
+TBD
+## Tasks
+TBD
+## Next
+TBD
+## Links
+- [project docs](https://dendron.so/notes/37f3623c-d87e-4181-8531-2edb578d3391.html)
+- [issues](https://github.com/dendronhq/dendron/labels/pro.git)

Added: vault/dendron.roadmap.project.n.2020.long-term-sustainability.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.long-term-sustainability.md +71 -0

vault/dendron.roadmap.project.n.2020.long-term-sustainability.md ADDED Viewed

@@ -0,0 +1,71 @@
+---
+id: d892da5f-3667-4bfe-a8ba-e5ea3da4eb72
+title: Long term sustainability v0
+desc: ''
+updated: 1604945094990
+created: 1599501881180
+stub: false
+start: 2020.10.07
+end: 2020.11.29
+status: Next
+---
+## Goals
+Figure out and experiment with a long term business model for Dendron.
+## Details
+[Kevin](https://github.com/kevinslin) is the founder of Dendron and working on it full time. He funds it by selling Amazon stock every couple of months. While this works for now, it will eventually hit a wall.
+Kevin wants to work on Dendron full time for the forseeable future and would like to hire other people full time to do the same.
+## Tasks
+- [x] come up with different revenue plans
+- [x] launch the **environmentalist plan**
+  - re-curring payment to support development of Dendron
+  - access to special once a month zoom chat about features
+  - swag
+  - discord icon
+  - discount for server side features
+## Next
+- server side features
+  - private hosting
+  - native sync
+  - server side pods (eg. everytime you add data to airtable, add an entry to Dendron)
+## Links
+- [project docs](https://dendron.so/notes/d892da5f-3667-4bfe-a8ba-e5ea3da4eb72.html)
+- [issues](https://github.com/dendronhq/dendron/labels/pro.lts-v0)
+## Notes
+### Revenue Ideas
+- pro status
+  - support dendron development using one time or recurring fee
+  - get a dendron sticker and special discord badge
+  - get discount when we launch sever feature rates
+- workshops
+- server features
+  - use **code-server** or something equivalent to run dendron inside a browser
+  - dedicated end2end sync
+  - hosted pods
+    - do daily import/export of notes from/to diff places
+- dendron private catalogues
+  - give people the option to build a paying subscription base for their published notes (eg. substack)
+- enterprise features
+  - active directory and support
+  - support remote mount point
+- mobile app
+- standalone client
+  - standalone dendron app
+    - maybe modified vscode (without coding)
+    - theia
+    - vscodium
+  - charge a pay what you can model?
+- wyswg client

Added: vault/dendron.roadmap.project.n.2020.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.md +9 -0

vault/dendron.roadmap.project.n.2020.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: 58247dfb-55b4-4269-9b37-42a90a0045ef
+title: '2020'
+desc: ''
+updated: 1600123491932
+created: 1600123491932
+stub: false
+---

Added: vault/dendron.roadmap.project.n.2020.pods.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.pods.md +51 -0

vault/dendron.roadmap.project.n.2020.pods.md ADDED Viewed

@@ -0,0 +1,51 @@
+---
+id: b1dbd32d-ca87-4489-9ba0-01bf7928cba5
+title: Pods v0
+desc: ''
+updated: 1603139155412
+created: 1599499136050
+stub: false
+start: 2020.09.07
+end: 2020.09.29
+status: In Progress
+---
+## Goal
+Make it possible for people to import/export their data between Dendron and **any other** platform that contains information a user might care about.
+## Details
+Dendron wants to be your **central digital nervous system** - our end goal is to be the **best possible way** to create, build, use, and share the knowledge that matters to you.
+To do that effectively, we believe its important that you have **full control of your information**. This means having your data available in plaintext markdown and having an note-taking tool that is local and open source. But we want to go further than that which is where [pods](TODO) come in.
+Dendron refers to a pod as anything you could conceivably use to store/publish notes. Evernote, Roam, static websites, twitter - any and all of these things are potential pods. The vision with pods is that you should be able to seamlessly move **your information** in and out a pod and in and out of Dendron.
+Unlike what the [notion](https://www.notion.so/) marketing folks might tell you, we don't believe there is a one size fits all approach when it comes to knowledge management, a concept that includes collecting articles, project management, journaling, collaboration, and basically any workflows that involve working with information.
+While Dendron will make it possible for you to do these things, it will also help you move your information to tools that do it better for a given use case. Imagine being able to collaborate on a note using [google docs](https://docs.google.com/), use the spreadsheet functionality in [airtable](https://airtable.com/) to organize and all the while keep a canonical copy of that note inside Dendron where it is just a lookup away.
+If you have ideas about pods and pod related workflows that you would like to see us build, please come discuss them with us in our newly created [#pods](https://discord.gg/8vjasHj) channel.
+## Tasks
+- [x] establish basic pod framework
+- [x] use pods via extension
+- [x] use pods via CLI
+- [x] create 2 pods
+- [ ] support custom pods
+- [ ] document pods
+## Next
+- community voting on pods
+- stabilize pod API
+## Links
+- [project docs](https://dendron.so/notes/b1dbd32d-ca87-4489-9ba0-01bf7928cba5.html)
+- [issues](https://github.com/dendronhq/dendron/labels/pro.pods-v0)
+## Related
+- [[dendron.topic.pod]]
+- [[pod proposal issue|dendron.roadmap.project.scratch.2020.09.07-164009]]

Added: vault/dendron.roadmap.project.n.2020.power-functionality.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.power-functionality.md +33 -0

vault/dendron.roadmap.project.n.2020.power-functionality.md ADDED Viewed

@@ -0,0 +1,33 @@
+---
+id: ff1b9ea5-6d0e-49b2-97d1-a7e31299164e
+title: Power functionality v0
+desc: ''
+updated: 1599501792934
+created: 1599501792934
+stub: false
+start: 2020.12.07
+end: 2020.12.15
+status: Next
+---
+## Goals
+Support power user functionality
+## Details
+TBD
+## Tasks
+- schemas
+  - [ ] [specify sections within notes](https://github.com/dendronhq/dendron/issues/248)
+## Next
+TBD
+## Links
+- [project docs](https://dendron.so/notes/ff1b9ea5-6d0e-49b2-97d1-a7e31299164e.html)
+- [issues](https://github.com/dendronhq/dendron/labels/pro.power-func-v0)

Added: vault/dendron.roadmap.project.n.2020.principles-and-values.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.principles-and-values.md +51 -0

vault/dendron.roadmap.project.n.2020.principles-and-values.md ADDED Viewed

@@ -0,0 +1,51 @@
+---
+id: 35d7d7bc-64a6-4850-9a54-7de7f43ad751
+title: Principles and Values
+desc: ''
+updated: 1599499842665
+created: 1599499842665
+stub: false
+start: 2020.09.07
+end: 2020.09.20
+status: Done
+---
+## Goals
+Come up with governing principals and values for the Dendron product and the Dendron Community. This item is complete and documented under [[dendron.principles]]
+## Details
+### Product Principles
+- speed: Dendron should be the fastest way for **people** to access the information they care about
+  - lookup should finish in under a second
+  - all parts of our toolchain should optimize for speed
+- ownership: users should have **full control** of their data and it should be our first principle to maximize this as much as possibility
+- interoperability: it should be possible to import/export your data from/to any other source where a user might want to use their information
+- easy to learn, hard to master: see [Bushnell's Law
+  ](https://en.wikipedia.org/wiki/Bushnell%27s_Law#:~:text=Bushnell's%20Law%20or%20Nolan's%20Law,first%20quarter%20and%20the%20hundredth.)
+### Community Values
+- open and inclusive: Dendron is a tool for **all users** that are interested in creating, building, using, and sharing knowledge. full stop.
+- documentation first: we don't just share what we learn in a chat at a moment in time. we make sure that the information remains accessible longer after we are gone. we do this by documenting useful information in [dendron](http://dendron.so/)
+- have it in writing
+### Tradeoffs
+You can't have something that is everything for everyone. While both characteristics matter, we agree to make these tradeoffs when necessary.
+- function over form
+  - in dendron, its more important for something to be useful than it is to be beautiful
+  - the focus in dendron should be about your content and the hierarchies that connect them
+- focus on speed
+  - we can't predict the future but its likely that no one will ever say that they wish their note taking experience to be slower
+  - when thinking about features and tool chain, bias for speed
+- focus on hierarchies
+  - while dendron supports backlinks and other forms of organizing notes, dendron's foundation is tooling to help you manage hierarchies
+- retrieval over insertion @kpathakota
+## Related
+- [[dendron.principles]]

Added: vault/dendron.roadmap.project.n.2020.qol.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.qol.md +39 -0

vault/dendron.roadmap.project.n.2020.qol.md ADDED Viewed

@@ -0,0 +1,39 @@
+---
+id: c4cb56af-ec13-4e57-aede-eb341e870736
+title: Quality of Life Improvements (QoL) v0
+desc: ''
+updated: 1599501500764
+created: 1599501500764
+stub: false
+start: 2020.10.07
+end: 2020.10.29
+status: Next
+---
+## Goals
+Dendron is many things but easy to use it is not quite (yet).
+## Details
+Make Dendron easy to onboard (even for non-technical users) and smooth some of the rough edges.
+## Tasks
+- [x] collect feedback from the community
+- [ ] support anchor based markdown links
+- [ ] [easier schema creation](https://github.com/dendronhq/dendron/issues/249)
+- [ ] easier note publication
+- [ ] improve initial onboarding
+- [ ] update note metadata in realtime
+- [ ] show graph view of backlinks (in addition to hierarchies)
+## Next
+- interactive tutorial?
+- support folders
+## Links
+- [project docs](https://dendron.so/notes/c4cb56af-ec13-4e57-aede-eb341e870736.html)
+- [issues](https://github.com/dendronhq/dendron/labels/pro.qol-v0)

Added: vault/dendron.roadmap.project.n.2020.recruit-gardeners.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.recruit-gardeners.md +16 -0

vault/dendron.roadmap.project.n.2020.recruit-gardeners.md ADDED Viewed

@@ -0,0 +1,16 @@
+---
+id: 750c86bc-9b72-46b5-9c08-865af1bed622
+title: Recruit Gardeners
+desc: ''
+updated: 1599501257121
+created: 1599501257121
+stub: false
+---
+## Goals
+Recruit additional gardeners (aka developers) that will help build Dendron for the long haul.
+## Details
+Dendron has an ambitious roadmap and a community with an unquenchable thirst for better ways of working with their information. These are all good things. That being said, the head gardener (Kevin) is stretched a little thin at the moment trying to do all these things and would benefit from having a few helping hands when it comes to developing features.

Added: vault/dendron.roadmap.project.n.2020.seeds.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.seeds.md +39 -0

vault/dendron.roadmap.project.n.2020.seeds.md ADDED Viewed

@@ -0,0 +1,39 @@
+---
+id: b81810f7-4d47-4870-ad2c-d4e48a49aa22
+title: Seeds v0
+desc: ''
+updated: 1599498995178
+created: 1599498995178
+stub: false
+start: 2020.09
+end: 2020.09.19
+status: Done
+---
+## Goal
+Make it easy for people to publish and find high quality notes for any topic they care about
+## Details
+Dendron lets anyone publish an online version of the notes inside their Dendron vault. The [Dendron Website](https://dendron.so/) is an example of a published vault.
+Dendron seeds is a project to to curate notes from existing open source material. This means re-mixing existing open source content into public references. For example, [og-aws](https://github.com/open-guides/og-aws) is a fantastic resource for AWS. [TLDR](https://github.com/tldr-pages/tldr) is a great reference for CLI. The former is only available as a README, the latter via the console. It should be easy to take the content from these sites and publish them as public Dendron vaults. The information in these vaults can also be enriched from other sources. In this way, Dendron can help build the highest quality, most up to date, information for any respective domain that people care about.
+## Tasks
+- [x] establish basic seed framework
+- [x] populate seeds using CLI
+- [x] create ~~3~~ 2 seeds in 3 ~~2~~ different verticals  #wip
+  - [x] aws
+  - [x] open pkm
+## Next
+- use seeds from within the dendron extension
+- automatically keep seeded vaults up to date
+- create index of high quality seeds
+## Links
+- [issues](https://github.com/dendronhq/dendron/labels/pro.seeds-v0)

Added: vault/dendron.roadmap.project.n.2020.server-migration.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.2020.server-migration.md +221 -0

vault/dendron.roadmap.project.n.2020.server-migration.md ADDED Viewed

@@ -0,0 +1,221 @@
+---
+id: 725d99be-fadd-4464-88c3-0a5fcc7292c7
+title: Server Migration
+desc: ''
+updated: 1603982170477
+created: 1599501616541
+stub: false
+start: 2020.09.23
+end: 2020.10.30
+status: In Progress
+---
+## Goals
+Migrate the Dendron to (local) client &lt;-> server architecture
+## Details
+Dendron's current architecture can be found [here](https://dendron.so/notes/c160ddce-edec-4f6e-841b-418d6030fa37.html). Currently, all of Dendron's indexing capabilities is provided by the `dendron engine` as a library which is included in every extension that uses it. This has many drawbacks - every extension re-indexes all notes and also blocks the client (vscode) during this process.
+The Dendron server migration is to move Dendron to a client server architecture. Note that the migration will involve standing up **two servers**: one for language server functionality (the lsp server), and another for dendron's [lookup](https://dendron.so/notes/a7c3a810-28c8-4b47-96a6-8156b1524af3.html) capabilities (the express server).
+The rationale for having two servers is discussed [here](https://discordapp.com/channels/717965437182410783/748936364283920495/759153642644701285).
+They are also elaborated upon [here](https://discordapp.com/channels/717965437182410783/735365126227493004/765435624878505985)
+Instead of calling the engine directly, the Dendron extension, as well as related plugins, will communicate to Dendron's server using IPC and on local ports.
+## Tasks
+- [x] add LSP server to Dendron (0.12)
+- [x] add api server to Dendron (0.12)
+- [x] hook server into dendron startup (0.12.4)
+- [x] migrate lookup to server model
+  - [x] support query notes (0.12.6)
+  - [x] support query notes with schema (0.12.6)
+  - [x] support write notes (0.12.6)
+  - [x] support write note with schema (0.12.6)
+  - [x] support delete note (0.12.7)
+  - [x] support query schema (0.12.7)
+  - [x] support write schema (0.12.7)
+  - [x] support delete schema  (0.12.7)
+- [x] optimize server lookup performance (0.12.7)
+- [x] enable file watcher (0.12.7)
+- [x] dendron tree view (0.12.7)
+- [x] migrate commands
+  - [x] scratch note (0.12.7)
+  - [x] journal note (0.12.7)
+  - [x] copy note command (0.12.7)
+  - [x] copy note url (0.12.7)
+  - [x] lookup scratch note (0.12.7)
+  - [x] lookup journal note (0.12.7)
+  - [x] global journal note (0.12.7)
+  - [x] build pod (0.12.8)
+  - [x] rename note
+  - [x] archive hierarchy
+  - [x] refactor hiearchy
+  - [x] doctor
+- [x] integration tests for all server functionality
+## Next
+- migrate bundled extensions to server model
+- use custom goto definition provider
+- use custom backlink definition provider
+- use schema based completions
+## Configuration
+To enable server mode, update the following setting in your workspace settings `"dendron.useExperimentalLSPSupport": true`. Run `> Developer: Reload Window` afterwards for the changes to take effect.
+## Links
+- [project docs](https://dendron.so/notes/725d99be-fadd-4464-88c3-0a5fcc7292c7.html)
+- [issues](https://github.com/dendronhq/dendron/labels/pro.server-migration)
+## Related
+- [[dendron.topic.pod]]
+- [[pod proposal issue|dendron.roadmap.project.scratch.2020.09.07-164009]]
+<!--
+### Breakdown
+- create `@dendronhq/lsp-server` package
+- create interface btw lsp -> engine
+- implement a basic **new** feature using lsp (eg. hover preview of link) and delegate to lsp
+- route basic **old** feature to lsp (eg. go to definition from markdown-notes)
+- everything else
+### Design
+- components
+    - [[p.dendron-extension]]: vscode extension
+    - [[p.engine-v0]]: current dendron engine
+    - [[p.engine-server]]: dendron lsp engine
+    - [[p.engine-client]]: dendron lsp client
+- concepts
+    - all links: note refs, wiki links, md links
+- architecture today:
+    - [[p.dendron-extension]] -> [[p.engine-v0]]
+- architecture after migration
+    - user commands: [[p.dendron-extension]] -> [[p.engine-client]] -> [[p.engine-server]]
+    - lsp specific actions: vscode -> [[p.engine-server]]
+### Challenges
+#### Non-lsp functionality
+LSP provides language specific features but doesn't provide us with the equivalent of [[dendron.topic.lookup]]. If we want to consolidate the indexing inside [[p.engine-server]], we need a way to query the index via [[p.engine-client]]. Below are a few proposals to do this:
+1. Write all metadata to JSON file. Use filewatcher for engine-client to watch the JSON file
+2. Add a custom listener to [[p.engine-server]] that listens for special [[p.engine-client]] requests on a standalone port
+### Flows
+#### initialization
+- user activates dendron workspace
+- activates [[p.engine-server]] and [[p.engine-client]]
+- [[p.engine-server]] indexes all files in workspace and sets file watcher to watch for changes
+- [[p.engine-client]] gets notified when indexing is complete
+#### sync
+- [[p.engine-server]] will track the following changes
+    - frontmatter updates
+    - note updates
+    - schema updates
+    - dendron specifc config
+#### commands
+This describes what will be the main provider of the functionality that is currently done via the engine.
+- Create Daily Journal Note
+    - provider: [[p.engine-client]]
+- Create Journal Note
+    - provider: [[p.engine-client]]
+- Create Scratch Note
+    - provider: [[p.engine-client]]
+- Copy Note Link
+    - provider: [[p.engine-client]]
+- Copy Note Ref
+    - provider: [[p.engine-client]]
+- Delete Node
+    - provider: [[p.engine-client]]
+- New Note From Selection
+    - provider: [[p.engine-client]]
+- Rename Note
+    - provider: [[lsp.rename-and-prepare-rename]]
+- Show Preview
+    - provider: [[p.dendron-mpe]]
+- Lookup
+    - provider: [[p.engine-client]]
+- Lookup Schema
+    - provider: [[p.engine-client]]
+- Open Link
+    - provider: [[p.engine-client]]
+- Reload Index
+    - provider: [[p.engine-server]]
+- Archive Hierarchy
+    - provider: [[lsp.rename-and-prepare-rename]]
+- Refactor Hierarchy
+    - provider: [[lsp.rename-and-prepare-rename]]
+- Go Up
+    - provider: [[p.engine-client]]
+- Go Next Sibling
+    - provider: [[p.engine-client]]
+- Go Previous Sibling
+    - provider: [[p.engine-client]]
+- Go Down
+    - provider: [[p.engine-client]]
+- Initialize Workspace
+    - provider: [[p.dendron-extension]]
+- Change Workspace
+    - provider: [[p.dendron-extension]]
+- Show Help
+    - provider: [[p.dendron-extension]]
+- Build Pod
+    - provider: [[p.engine-client]]
+- Configure Pod
+    - provider: [[p.engine-client]]
+- Import Pod
+    - provider: [[p.engine-client]]
+- Export Pod
+    - provider: [[p.engine-client]]
+- Doctor
+    - provider: [[p.engine-client]]
+- Dendron:Dev: Open Logs
+    - provider: [[p.engine-client]]
+### Additional Functionality Via LSP
+- [[lsp.publish-diagnostics]]
+- [[lsp.completion-and-completion-resolve]]
+    - all links
+    - frontmatter fields
+    - document headers
+- [[lsp.hover]]
+    - show preview of all links (exclude note refs)
+- [[lsp.signature-help]]
+- [[lsp.definition]]
+    - all links
+- [[lsp.type-definition]]
+    - goto definition for all links
+    - go to definition for schema elements
+- [[lsp.implementation]]
+    - inside schema, trigger this to look at all notes that implement said schema
+- [[lsp.references]]
+    - backlinks
+- [[lsp.document-highlight]]
+    - TBD
+- [[lsp.document-symbol]]
+- [[lsp.code-action]]
+    - fix frontmatter according to schema
+- [[lsp.codelens-and-codelens-resolve]]
+- [[lsp.documentlink-and-documentlink-resolve]]
+- [[lsp.documentcolor-and-color-presentation]]
+- [[lsp.formatting]]
+    - format according to markdown-lint and schema
+- [[lsp.range-formatting]]
+- [[lsp.ontype-formatting]]
+- [[lsp.rename-and-prepare-rename]]
+- [[lsp.folding-range]]
+-->

Added: vault/dendron.roadmap.project.n.backlog.calendar-integration.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.backlog.calendar-integration.md +106 -0

vault/dendron.roadmap.project.n.backlog.calendar-integration.md ADDED Viewed

@@ -0,0 +1,106 @@
+---
+id: 61833b7d-1cfe-4500-b78d-b30962a906cd
+title: Google Calendar Pod
+desc: ''
+updated: 1608485512280
+created: 1602708411014
+stub: false
+---
+## Goals
+Support integrating calendars like google calendar with Dendron
+## Proposal
+- incorporate as a Google Calendar Pod
+### Import
+```yml
+apiToken:
+range: allEvents
+```
+### Sync
+```yml
+```
+## Publish
+- configuration:
+  - summary
+  - location
+  - description
+  - start
+  - end
+- not covered
+  - recurrence
+  - attendees
+  - reminders
+- flow
+```bash
+cd /path/to/workspace
+dendron-cli dendron-cli publishPod --wsRoot . --vault ./vault --podId dendron.gcal --noteByName gcal.test --config /tmp/config.yml
+```
+### Resources
+- api: <https://developers.google.com/calendar/create-events>
+- sdk:
+```ts
+// Refer to the Node.js quickstart on how to setup the environment:
+// https://developers.google.com/calendar/quickstart/node
+// Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any
+// stored credentials.
+var event = {
+  'summary': 'Google I/O 2015',
+  'location': '800 Howard St., San Francisco, CA 94103',
+  'description': 'A chance to hear more about Google\'s developer products.',
+  'start': {
+    'dateTime': '2015-05-28T09:00:00-07:00',
+    'timeZone': 'America/Los_Angeles',
+  },
+  'end': {
+    'dateTime': '2015-05-28T17:00:00-07:00',
+    'timeZone': 'America/Los_Angeles',
+  },
+  'recurrence': [
+    'RRULE:FREQ=DAILY;COUNT=2'
+  ],
+  'attendees': [
+    {'email': 'lpage@example.com'},
+    {'email': 'sbrin@example.com'},
+  ],
+  'reminders': {
+    'useDefault': false,
+    'overrides': [
+      {'method': 'email', 'minutes': 24 * 60},
+      {'method': 'popup', 'minutes': 10},
+    ],
+  },
+};
+calendar.events.insert({
+  auth: auth,
+  calendarId: 'primary',
+  resource: event,
+}, function(err, event) {
+  if (err) {
+    console.log('There was an error contacting the Calendar service: ' + err);
+    return;
+  }
+  console.log('Event created: %s', event.htmlLink);
+});
+```
+### Export
+## Flows

Added: vault/dendron.roadmap.project.n.backlog.color-tabs.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.backlog.color-tabs.md +55 -0

vault/dendron.roadmap.project.n.backlog.color-tabs.md ADDED Viewed

@@ -0,0 +1,55 @@
+---
+id: a4252774-0c08-4bca-a1b5-b6f369908aeb
+title: Related
+desc: ''
+updated: 1603426502775
+created: 1602430633050
+---
+- [github issue](https://github.com/dendronhq/dendron/issues/261)
+## Goals
+Support custom colorization of tabs in Dendron, specified by schema.
+## Details
+VSCode has the following settings for tabs.
+```
+"workbench.colorCustomizations": {
+    "tab.activeBackground": "#FFFFFF",
+    "tab.activeForeground":"#000000",
+    "tab.inactiveForeground":"#FFFFFF",
+    "tab.inactiveBackground":"#000000",
+    "tab.border":"#FFFFFF"
+}
+```
+The properties that can be customized are `activeBackground` and `inactiveBackground`.  In addition to tab color, you can also customize the title bar (top horizontal), activity bar (side panel) and status bar(bottom bar). When they are all set, it looks something like this
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/project.color-tabs.jpg)
+## Proposal
+### Set custom tab color based on schema.
+```yml
+schemas:
+- id: project
+  tabColor:
+    value: #FFFFFF
+    recursive: false # default: true, optional param
+```
+By default, `tabColor` would be recursive, so any child schemas would also have the property applied. More specific `tabColor` settings on child schemas would take precedence over parent `tabColor` settings.
+Currently, the only way to set tab color is via the settings file which means Dendron would dynamically update your workspace settings as you navigate files.
+- [per editor/tab background color](https://github.com/Microsoft/vscode/issues/35379)
+- settings:
+  - workbench.colorTheme: per workspace/folder settings
+  - tab.inactiveForeground
+  - tab.inactiveBackground
+- [discord](https://discordapp.com/channels/717965437182410783/735365126227493004/764283816130248734)
+- [color tabs extension](https://marketplace.visualstudio.com/items?itemName=orepor.color-tabs-vscode-ext)

Added: vault/dendron.roadmap.project.n.backlog.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.backlog.md +9 -0

vault/dendron.roadmap.project.n.backlog.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: 529fb02a-3ca9-4fbc-bcba-9435f8d13e89
+title: Backlog
+desc: ''
+updated: 1602132400901
+created: 1602132400901
+stub: false
+---

Added: vault/dendron.roadmap.project.n.backlog.mindmap-view.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.backlog.mindmap-view.md +66 -0

vault/dendron.roadmap.project.n.backlog.mindmap-view.md ADDED Viewed

@@ -0,0 +1,66 @@
+---
+id: 533857a4-3dcb-478e-9877-5ab7f94ed6e6
+title: Mindmap View
+desc: ''
+updated: 1603636828393
+created: 1603426485399
+---
+## Goals
+Support a mindmap view for notes in Dendron.
+## Use Case
+- being able to see high level view of your notes
+- being able to focus on specific parts of the note hierarchy
+## Details
+This project discusses the best way to implement a mind-map view into Dendron that aligns with the principles of hierarchy-first note-taking.
+## Proposal
+Create a view in Dendron that will visualise a note in dendron using a mindmap format, and show it's siblings, parents and children organised legibly and semantically. This can be implemented using the React Sortable Tree plugin, which will also be used for creating schemas.
+#### Organising the information connected to a node in a semantic and legible manner
+A standard graph view spreads the connected nodes arbitratily around the outside of a parent node. This is useful for understanding the general 'shape' of the connections between notes, but in order to understand the immediate connections between any particular note it is easier if they are arranged in a structured and comprehensible fashion. A view that visualises notes in a mindmap style format can achieve this.
+#### Activating mindmap view
+The mindmap view can be triggered through the command palette as a Dendron command, as well as from an icon in the Activity Bar, or through the right-click context menu on a note. Launching it from the activity bar or command palette will launch it in the root of your vault, while launching it from the right click context menu on a note will open it focused to that particular note.
+#### Indication of related note
+When a note is opened from the mindmap view (or the mindmap view is opened from a note), it is linked so that navigating to other notes via the mindmap panel will open them in that same panel. This can be indicated by an icon in the menu bar of the linked panel, or an icon in the tab in the linked panel.
+#### Creation of new child notes by clicking
+A '+' icon on a note when clicked can add a child note underneath that note.
+#### Schema visualisation
+A mindmap-style visualisation lends itself to visualising the abstract concept of a schema. A note with a schema applied shows the potential nodes that it could have according to the schema as transparent notes with a '+' symbol, which when clicked will create that note.
+#### Expanding scope of mindmap focus
+The mindmap view can also be expanded to show additional generations of notes from the same focused note (the grandparents and grandchildren of the focused note). There are '+' and '-' buttons in the mindmap view panel to increase or decrease the amount of visible generations.
+#### Configuration options
+TBD
+## Questions
+### What is the difference between this and Dendron's graph view?
+The graph view shows an overview of your _entire knowledge base_ and can be traversed by scrolling and zooming. This can be useful for understand the general structure of all your notes, and the broad relationships between domains in your hierarchy but is less suited for focusing on a particular domain.
+The mindmap view would allow users to focus their attention on a particular node, it's siblings, parents and children, view them in a visually organised manner, and traverse their notes by selecting notes directly attached to that domain. In this sense, it is more suited to giving you an overview of a particular _domain_.
+## Resources
+- [The Brain App](https://www.thebrain.com/)
+- [Discussion](https://discordapp.com/channels/717965437182410783/739186036495876126/766252142549270550)
+- [React Sortable Tree](https://github.com/mikcaweb/react-sortable-tree)

Added: vault/dendron.roadmap.project.n.backlog.org-mode.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.backlog.org-mode.md +59 -0

vault/dendron.roadmap.project.n.backlog.org-mode.md ADDED Viewed

@@ -0,0 +1,59 @@
+---
+id: c3800271-dd56-46fb-8de7-e850f3c006b7
+title: Org Mode
+desc: ''
+updated: 1608485548393
+created: 1602131829574
+stub: false
+---
+## Goals
+Support org-mode sytnax within Dendron
+## Details
+This project discusses how to best incorporate org-mode functionality into dendron
+## Proposals
+1. support {file}.org files
+2. support `org` syntax within `md` files
+### 1. Support {file}.org files
+- have dendron support .org files
+- pros:
+  - works with existing vscode extensions (eg. [vscode org-mode](https://marketplace.visualstudio.com/items?itemName=tootone.org-mode)
+  - can be edited in emacs
+- cons:
+  - uncertain how to implement dendron specific syntax and features (eg. note references, schemas, etc)
+## 2. support `org` syntax within `md` files
+- implement org-mode as a fenced block
+- pros:
+  - compatible with existing markdown tool chain
+- cons:
+  - might not be compatible with emacs and existing org-mode toolchain
+## Thoughts
+Currently i'm leaning towards 1). folks that want org-mode support in dendron can create markdown files and manually set the filetype to org mode. it's not ideal since you lose the preview but other functions like lookup still work.
+Changing filetype has a custom command. VSCode has a default shortcut (`cmd+k m` on mac) that can be re-mapped.
+```
+"command": "workbench.action.editor.changeLanguageMode",
+```
+## Next
+- [ ] look at prior work in this area (embedding org-mode in other applications)
+- [ ] collect feedback
+- [ ] figure out if `changeLanguageMode` accepts args (would be great if you could toggle to org-mode and back using a single shortcut)
+- [ ] schedule org-mode implementation

Added: vault/dendron.roadmap.project.n.md

Files changed (1) hide show

vault/dendron.roadmap.project.n.md +9 -0

vault/dendron.roadmap.project.n.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: 167bd57c-fb54-4a71-85b2-c26ba6df29fc
+title: 'Entries'
+desc: ''
+updated: 1601139430372
+created: 1601139430372
+stub: false
+---

Added: vault/dendron.roadmap.project.scratch.2020.09.07-121834.md

Files changed (1) hide show

vault/dendron.roadmap.project.scratch.2020.09.07-121834.md +54 -0

vault/dendron.roadmap.project.scratch.2020.09.07-121834.md ADDED Viewed

@@ -0,0 +1,54 @@
+---
+id: 012b49e8-7638-4856-afc2-2db3c6406a86
+title: Log
+desc: ''
+updated: 1599506314235
+created: 1599506314235
+stub: false
+source: >
+  -
+  https://discordapp.com/channels/717965437182410783/735365126227493004/752606691518054450
+---
+## Jojo
+@kevins8 vaults have somewhat sparse documentation, especially possible multi-vault setups. Let's say I'd like to separate work and home into distinct vaults, maybe even so that other vault is a symbolic link to dropbox or whatever. Would that work? Also, what happens if there's a filename collision across vaults?
+## Jojo
+multi-vault support is on the roadmap for this year. for naming collisions, i was thinking the following:
+- by default, surface all results with the vault name in the prefix
+say a user has the following vaults
+```
+.
+└── workspace
+    ├── kevin-vault
+    │   └── python.hello.md
+    └── jojo-vault
+        └── python.hello.md
+```
+user enters the following lookup: `python.hello`
+they should see the following result
+```
+python.hello - kevin vault
+python.hello - jojo vault
+```
+we can also introduce a vault specific prefix (eg. {vault}/{path}) to un-ambiguously specify our result
+user would type `kevin-vault/python.hello` to specify they want to access `kevin-vault`
+"why don't we just show all matches for an unprefixed link" - this would work inside vscode, but if the user just publishes the workspace with conflicting vaults, I guess the link must point to some single pre-selected place(?). Also, I think the intent behind the link is to point to a single location, so asking user to fix it would probably be reasonable.
+There's probably all kind of complex scenarios that we could envision (e.g. what if the user would like to merge domains across vaults and show all merged notes in the published page as a merged web page?), but then again 99.9% of the real cases probably just want to use multiple folders and avoid conflicts. Showing errors would probably be the easiest and still sufficient solution.
+### Kevin
+coming back to this thread. agree with your conclusion. the other solution would be to generate a popup/intermediary page for links with multiple destinations and let the user choose.
+e
+for v1, would bias for what you suggested and error at build time.

Added: vault/dendron.roadmap.project.scratch.2020.09.07-121952.md

Files changed (1) hide show

vault/dendron.roadmap.project.scratch.2020.09.07-121952.md +22 -0

vault/dendron.roadmap.project.scratch.2020.09.07-121952.md ADDED Viewed

@@ -0,0 +1,22 @@
+---
+id: 02b1c04d-fc7e-4af9-9ffc-a661ac3da394
+title: Log
+desc: ''
+updated: 1599506392418
+created: 1599506392418
+stub: false
+source: >
+  -
+  https://discordapp.com/channels/717965437182410783/735365126227493004/752607009068810340
+---
+## bsqrd
+I hve a question around the same context, say you consider all of your vault to be private and not really shareable, but you would still like to share bits and pieces from a couple notes and make them public. Would creating, say a public._ or garden._ hierarchy and then in each note you would reference the interesting bits and pieces from the rest of the private notes be feasible ?
+I guess to simplify my question: can you publish notes that have references to private / non-published notes ?
+## kevin
+the mental model I had in my head for vaults (and its not set in stone) is that a hierarchy could exist spread across multiple vaults. each vault is a github repo. you can there fore have a public vault and a private vault and you can choose to share everything in one but nothing in the other
+what's nice about this model is that you still get to have one unified hierarchy that can span any number of vaults

Added: vault/dendron.roadmap.project.scratch.2020.09.07-164009.md

Files changed (1) hide show

vault/dendron.roadmap.project.scratch.2020.09.07-164009.md +103 -0

vault/dendron.roadmap.project.scratch.2020.09.07-164009.md ADDED Viewed

@@ -0,0 +1,103 @@
+---
+id: 700b02fc-1e6c-46b1-8d68-5d8e17a55d33
+title: Evernote Pod Proposal
+desc: ''
+updated: 1599522009420
+created: 1599522009420
+stub: false
+---
+- link to tool: <https://evernote.com>
+- one line description: online note taking tool that organizes notes using notebooks and tags
+- is there a public api available (if so, please provide link)? yes
+  - <https://dev.evernote.com/doc/>
+- are there existing (preferably javascript compatible) libraries that can import and/or export to this pod? (if so, please list them. if there aren't libraries, an example of importing is also good): yes
+  - import:
+    - import del.icio.us bookmarks into evernote: <https://github.com/jorgemanrubia/evernicious> #ruby #example
+  - export:
+    - export evernote notes: <https://github.com/akosbalasko/yarle> #typescript
+- are there existing (preferably javascript compatible) libraries that can convert from/to the data format used in this pod? (if so, please list them): yes
+  - convert from
+    - <https://github.com/akosbalasko/yarle> #typescript
+  - convert to
+## Import
+&lt;What does import look like? How will the organization of the source pod be mapped onto Dendron's Hierarchy?>
+### mappings
+- notebook stack & notebooks: hierarchy
+- tags -> tags
+### example
+- evernote
+```
+- Cookbook (notebook stack)
+    - Meat (notebook)
+        - meat note 1
+        - meat note 2
+        - ...
+    - Vegetables (notebook)
+        - ...
+```
+- dendron
+```
+- cookbook
+- cookbook.meat
+- cookbook.meat.meat-note-1
+- cookbook.meat.meat-note-2
+- cookbook.vegetables
+```
+## Build
+&lt;What does build look like? What steps need to occur prior to exporting your Dendron notes>
+## Export
+&lt;What does export look like? How will we map Dendron's hierarchies to the destination pod's organization?>
+### mappings
+- hierarchy -> notebook stack or notebook (user can configure on a per hierarchy basis)
+-
+- dendron
+```
+- cookbook.meat
+- cookbook.meat.meat-note-1
+- cookbook.meat.meat-note-2
+- cookbook.vegetables
+```
+<!-- ## Configuration
+<What might a configuration file look like to help make sure your data is formatted correctly ?>
+e.g.
+destinations:
+  - destination:
+      base: People
+      table: Interactions
+    src:
+      meet.{today}.*
+    mapping:
+      fm.created: DateV2
+      fm.type: Type
+      section.noes: Notes
+      section.people: People
+ -->
+## Example Use Cases
+&lt;e.g. Sync notes from meetings with an airtable tracking meetings across days and people>

Added: vault/dendron.roadmap.project.scratch.2020.09.md

Files changed (1) hide show

vault/dendron.roadmap.project.scratch.2020.09.md +9 -0

vault/dendron.roadmap.project.scratch.2020.09.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: f81bd621-b918-4003-b6d8-6efd99a42a5b
+title: 09
+desc: ''
+updated: 1601139430377
+created: 1601139430377
+stub: false
+---

Added: vault/dendron.roadmap.project.scratch.2020.md

Files changed (1) hide show

vault/dendron.roadmap.project.scratch.2020.md +9 -0

vault/dendron.roadmap.project.scratch.2020.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: dba0543d-dd60-4d8a-904e-d347f9f862ee
+title: '2020'
+desc: ''
+updated: 1601139430377
+created: 1601139430377
+stub: false
+---

Added: vault/dendron.roadmap.project.scratch.md

Files changed (1) hide show

vault/dendron.roadmap.project.scratch.md +9 -0

vault/dendron.roadmap.project.scratch.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: c17fa26b-702b-47b7-a9a2-4a8218fc26e4
+title: Scratch
+desc: ''
+updated: 1601139430377
+created: 1601139430377
+stub: false
+---

Added: vault/dendron.roadmap.project.template.md

Files changed (1) hide show

vault/dendron.roadmap.project.template.md +22 -0

vault/dendron.roadmap.project.template.md ADDED Viewed

@@ -0,0 +1,22 @@
+---
+id: 28acd3e7-2102-4b8d-8d69-0d7b2f83bb54
+title: Template
+desc: ''
+updated: 1600842066371
+created: 1600842066371
+stub: false
+start: null
+end: null
+status: null
+---
+## Goal
+## Details and Discussion
+## Release Notes
+## Tasks
+- [ ]
+- [ ]

Added: vault/dendron.scratch.2020.09.12-091632.md

Files changed (1) hide show

vault/dendron.scratch.2020.09.12-091632.md +21 -0

vault/dendron.scratch.2020.09.12-091632.md ADDED Viewed

@@ -0,0 +1,21 @@
+---
+id: 65745697-0f30-43d8-9085-a213e8227e8b
+title: data
+desc: ''
+updated: 1599927392112
+created: 1599927392112
+stub: false
+---
+### opts.replaceRefs
+```ts
+engine:DendronEngine {notes: {…}, initialized: true, props: {…}, store: FileStorage, fuse: Fuse, …}
+imageRefPrefix:undefined
+refReplacements:{
+    wikiLink2Html:false
+    wikiLink2Md:true
+    wikiLinkPrefix:''
+    wikiLinkUseId:true
+}
+```

Added: vault/dendron.scratch.2020.09.md

Files changed (1) hide show

vault/dendron.scratch.2020.09.md +9 -0

vault/dendron.scratch.2020.09.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: 8b563033-ce98-4142-868d-277dc34c2d4c
+title: 09
+desc: ''
+updated: 1600448077610
+created: 1600448077610
+stub: false
+---

Added: vault/dendron.scratch.2020.11.13-123350.md

Files changed (1) hide show

vault/dendron.scratch.2020.11.13-123350.md +25 -0

vault/dendron.scratch.2020.11.13-123350.md ADDED Viewed

@@ -0,0 +1,25 @@
+---
+id: 56f29f63-9803-4870-979d-c795c36e2bcb
+title: Tags
+desc: ''
+updated: 1605585526413
+created: 1605299633017
+---
+- multi vault (current)
+  - make it possible to have multiple issues
+- publishing 2.0
+  - multiplayer mode
+- preview 2.0
+- visualizations 2.0
+- tree view 2.0
+## status
+- good first issue
+## size

Added: vault/dendron.scratch.2020.11.md

Files changed (1) hide show

vault/dendron.scratch.2020.11.md +13 -0

vault/dendron.scratch.2020.11.md ADDED Viewed

@@ -0,0 +1,13 @@
+---
+id: 9f30ca08-965e-4896-ae74-d151d101bd18
+title: '11'
+desc: ''
+updated: 1605320735084
+created: 1605320735084
+stub: false
+parent: eead7fd1-f43e-44a1-bee3-2550d83e5476
+children:
+  - 56f29f63-9803-4870-979d-c795c36e2bcb
+---

Added: vault/dendron.scratch.2020.md

Files changed (1) hide show

vault/dendron.scratch.2020.md +9 -0

vault/dendron.scratch.2020.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: eead7fd1-f43e-44a1-bee3-2550d83e5476
+title: '2020'
+desc: ''
+updated: 1600448077609
+created: 1600448077609
+stub: false
+---

Added: vault/dendron.scratch.md

Files changed (1) hide show

vault/dendron.scratch.md +10 -0

vault/dendron.scratch.md ADDED Viewed

@@ -0,0 +1,10 @@
+---
+id: 9688f51b-49fb-4012-8845-0012f0dcf56f
+title: Scratch
+desc: ''
+updated: 1600448077609
+created: 1600448077609
+stub: false
+nav_exclude: true
+---

Added: vault/dendron.template.design.md

Files changed (1) hide show

vault/dendron.template.design.md +10 -0

vault/dendron.template.design.md ADDED Viewed

@@ -0,0 +1,10 @@
+---
+id: 861cbdf8-102e-4633-9933-1f3d74df53d2
+title: Reference
+desc: ''
+updated: 1602033087611
+created: 1602033087611
+stub: false
+---

Added: vault/dendron.template.example.md

Files changed (1) hide show

vault/dendron.template.example.md +10 -0

vault/dendron.template.example.md ADDED Viewed

@@ -0,0 +1,10 @@
+---
+id: a7c3a810-28c8-4b47-96a6-8156b1525af3
+title: Example Template
+desc: ''
+updated: 1595952505038
+created: 1595952505038
+stub: false
+---
+I am text from a template.

Added: vault/dendron.template.md

Files changed (1) hide show

vault/dendron.template.md +10 -0

vault/dendron.template.md ADDED Viewed

@@ -0,0 +1,10 @@
+---
+id: 8e2272bd-ad24-4806-b588-da2bcfa6ea11
+title: Template
+desc: ''
+updated: 1596318372330
+created: 1596318372330
+stub: false
+nav_exclude: true
+---

Added: vault/dendron.testimonials.ben.md

Files changed (1) hide show

vault/dendron.testimonials.ben.md +11 -0

vault/dendron.testimonials.ben.md ADDED Viewed

@@ -0,0 +1,11 @@
+---
+id: e6e596c7-6407-457b-b90d-9f2006aa9e51
+title: Ben
+desc: ''
+updated: 1614907233285
+created: 1614907201815
+---
+>  Once you start using Dendron you never look back. Saving all the files in one folder is incredibly liberating, fast and efficient. Try it for a few days and you will see. Getting your thoughts and information down into a hierarchy is so quick and easy. I am loving the experience. (I have only been using Dendron for a few days now. And it is a game changer for me. CTL + L is your friend.)
+- Ben Vautier, Co-Founder

Added: vault/dendron.testimonials.ed.md

Files changed (1) hide show

vault/dendron.testimonials.ed.md +12 -0

vault/dendron.testimonials.ed.md ADDED Viewed

@@ -0,0 +1,12 @@
+---
+id: e836000e-2ef9-4d9e-af11-1bdfde171a52
+title: Ed
+desc: ''
+updated: 1607965554626
+created: 1599936228898
+stub: false
+---
+> There is a learning curve to getting to know Dendron, but I find it a little like Excel - once you are in and tame the beast, it is hard to get out.
+- Ed, Accountant

Added: vault/dendron.testimonials.luke.md

Files changed (1) hide show

vault/dendron.testimonials.luke.md +12 -0

vault/dendron.testimonials.luke.md ADDED Viewed

@@ -0,0 +1,12 @@
+---
+id: 33d46152-89dd-4d7b-a4b6-1223d4fa8df8
+title: Luke
+desc: ''
+updated: 1607965511584
+created: 1603729976071
+---
+> Hierarchies [are] such a game changer, and is simultaneously what put me off trying Dendron (I really wanted to try the "flat hierarchy with just links" concept) and later drew me in again. I just couldn't organise myself with a flat structure and ended up spreading notes out.
+> I think the key thing that changed my perspective was the ease of restructuring hierarchies, it gives you the confidence to just write, safe in the knowledge that you can just restructure it later
+- Luke Carrier, Site Reliability Engineer

Added: vault/dendron.testimonials.md

Files changed (1) hide show

vault/dendron.testimonials.md +13 -0

vault/dendron.testimonials.md ADDED Viewed

@@ -0,0 +1,13 @@
+---
+id: b08155fe-c5c6-4d4c-a737-d500923f35ad
+title: Testimonials
+desc: ''
+updated: 1614907260928
+created: 1599596104324
+stub: false
+nav_order: 2.1
+---
+This page is a collection of nice things that people have said about Dendron. If you want to add to it, feel free to add it using the `Edit` link on the bottom of the page or messaging kevin at [kevin@dendron.so](mailto:kevin@dendron.so) 🙏
+![[dendron.testimonials.*]]

Added: vault/dendron.testimonials.myles.md

Files changed (1) hide show

vault/dendron.testimonials.myles.md +16 -0

vault/dendron.testimonials.myles.md ADDED Viewed

@@ -0,0 +1,16 @@
+---
+id: 2367a2af-c216-414b-88bf-02acd9d4eca4
+title: Myles
+desc: ''
+updated: 1607965546166
+created: 1599936132300
+stub: false
+---
+> I started taking organised notes in 1993. I had read 'Lila' by Robert Pirsing and 'The Tao of Physics' by Fritjof Capra, both of whom used index card systems to organise those books. I've never stopped taking notes since 1993. I may have a few thousand more notes than @kevins8.
+> I've used apps - everything from Filemaker Pro, to Mark Bernstein's excellent Tinderbox, to DevonThink, to Tiddlywiki, to ones i've written myself, and dozens more, including the latest batch of 'tools for thought'.
+> Given my volume of notes over decades, I know a bit about the cul-de-sacs knowledge systems run into. I use new knowledge apps to see how they feel, but mostly studiously avoid getting stuck into complex systems and closed silos. I'm allergic to apps that are too limited for my volume and density of knowledge. I can't use Roam. I can almost use logseq. I can use dendron.
+> Kevin hid a copy of Vannevar Bush's 'As We May Think' in the dendron codebase. It's definitely true that the original vision of the hyperweb is back: something is changing today - a new level of literacy or a higher level of knowledge is emerging, and language, logic, and code are merging. This isn't the late 90's, no company is going to 'win'. Instead, a few pioneers are going to build a bridge to a new level  of thought for networked humanity.
+> Dendron stands apart from the pack. Kevin is on to something. Excited to see where he leads.
+-  Myles Byrne, Semantic Web Developer

Added: vault/dendron.testimonials.ryan.md

Files changed (1) hide show

vault/dendron.testimonials.ryan.md +21 -0

vault/dendron.testimonials.ryan.md ADDED Viewed

@@ -0,0 +1,21 @@
+---
+id: 0ddffabc-c78b-4765-a3df-8ffa35dd1391
+title: Ryan
+desc: ''
+updated: 1611363336731
+created: 1611363202953
+---
+> Here's my perspective as a full-time college librarian who's also a humanities grad student & journal editor:
+> I was interested in Obsidian briefly before choosing Dendron. The biggest factors for choosing Dendron are the hierarchical structure, the multiple vaults, and the many existing VS Code extensions.
+> Hierarchies make a lot more sense to my brain. And some of the research I've glanced at suggests it is better for PKM than tags or other free-form structures.
+> Having multiple vaults made me comfortable jumping fully into Dendron. I currently have 3 separate vaults: one for my daily life & work as a librarian/journal editor, a second for my dissertation-related things, and a third that my wife & I will soon start syncing on our separate computers. I'll eventually make a fourth for notes I'll publish on my website—but this is the start of the semester, and I have to avoid that kind of exciting but time-intensive project at the moment! I appreciate that references will work between these vaults—but I don't need to worry about accidentally sharing a note with a link to "project.kitchen-plumbing-disaster" with my dissertation advisor, or flood my wife's computer with my reading notes and dissertation idea fragments. This fundamental separation lets me feel comfortable using one tool for all these disparate domains.
+> Having the full range of existing VS Code extensions for things like Pandoc, BibTeX, or Zotero, plus web development, means that I don't need to hope that someone else involved with Obsidian, Foam, etc will make a plug-in that does what I need for an edge case use. Dendron plugs into a much larger pool of people, many of whose are doing academic and web-related work. I don't do much with data analysis, but I imagine it would be nice to use VS Code tools for Python or R in the same program one uses for academic writing.
+- Ryan, Librarian

Added: vault/dendron.testimonials.tom.md

Files changed (1) hide show

vault/dendron.testimonials.tom.md +12 -0

vault/dendron.testimonials.tom.md ADDED Viewed

@@ -0,0 +1,12 @@
+---
+id: cd55a110-0597-4d55-99d7-2bd63787959e
+title: Tom
+desc: ''
+updated: 1607965547196
+created: 1599936256433
+stub: false
+---
+> Dendron is awesome.  Each day the simple things are getting easier
+- Tom Diaz MD, Researcher/Technologist

Added: vault/dendron.testimonials.tyler.md

Files changed (1) hide show

vault/dendron.testimonials.tyler.md +10 -0

vault/dendron.testimonials.tyler.md ADDED Viewed

@@ -0,0 +1,10 @@
+---
+id: 1a7d8768-2056-448e-b587-9f56c104f5b3
+title: Tyler
+desc: ''
+updated: 1607965552845
+created: 1601136275766
+---
+> The last time I felt excited about learning a tool like this was when I started learning vim... it has never stopped and I suspect my usage of this tool will evolve similarly.
+- Tyler Nieman, Software engineeer/Illustrator

Added: vault/dendron.topic.capabilities.md

Files changed (1) hide show

vault/dendron.topic.capabilities.md +7 -0

vault/dendron.topic.capabilities.md ADDED Viewed

@@ -0,0 +1,7 @@
+---
+id: 11787828-866c-48f0-9b2b-4ad4e0519698
+title: Capabilities
+desc: ''
+updated: 1604209668061
+created: 1595952505033
+---

Added: vault/dendron.topic.capabilities.snapshot.md

Files changed (1) hide show

vault/dendron.topic.capabilities.snapshot.md +19 -0

vault/dendron.topic.capabilities.snapshot.md ADDED Viewed

@@ -0,0 +1,19 @@
+---
+id: 4473581a-cfdf-4d98-89a9-2955b308b669
+title: Snapshots
+desc: ''
+updated: 1604240847774
+created: 1604209673048
+---
+You can make a snapshot of your entire vault using the `Snapshot Vault` Command.
+This will save all your vaults into `snapshots/{current_timestamp}`
+## Commands
+((ref:[[dendron.topic.commands]]#snapshot vault:#*))
+You can restore your snapshots using the `Restore Vault` Command
+((ref:[[dendron.topic.commands]]#restore vault:#*))

Added: vault/dendron.topic.cli.md

Files changed (1) hide show

vault/dendron.topic.cli.md +187 -0

vault/dendron.topic.cli.md ADDED Viewed

@@ -0,0 +1,187 @@
+---
+id: 23a1b942-99af-45c8-8116-4f4bb7dccd21
+title: Dendron CLI
+desc: ''
+updated: 1614924024964
+created: 1600033791071
+---
+The Dendron CLI exposes Dendron's functionality via the command line.
+## Installation
+```
+npm install -g @dendronhq/dendron-cli
+```
+## Engine Commands
+### doctor 🚧
+Use doctor to perform specific fixes over your notes.
+- NOTE: the functionality here is different from what is available in the plugin version of [[Doctor|dendron.topic.commands#doctor]].
+```bash
+doctor helps you fix your notes
+Options:
+  --version     Show version number                                    [boolean]
+  --help        Show help                                              [boolean]
+  --wsRoot      location of workspace                                 [required]
+  --enginePort  If set, connecto to running engine. If not set, create new
+                instance of Dendron Engine
+  --action      what action the doctor should take
+                            [array] [choices: "h1ToTitle", "h1ToH2"]
+  --query       run doctor over a query                                 [string]
+  --limit       limit num changes                                       [number]
+  --dryRun      dry run                                                [boolean]
+```
+#### available actions
+- h1ToTitle: remove initial `h1` header and use it to replace contents of `title` field in frontmatter
+- h1ToH2: convert all initial `h1` header to `h2` header
+#### examples
+- convert all `h1` tags to frontmatter `title` values for the `readings` hiearchy
+```bash
+dendron-cli doctor --wsRoot . --action h1ToTitle --limit 10 --query "readings.*"
+```
+- see log
+```bash
+LOG_LEVEL=info LOG_DST=stdout dendron-cli doctor --wsRoot . --action h1ToTitle --limit 10
+```
+### launchEngineServer
+Launch the [[dendron server|dendron.roadmap.project.n.2020.server-migration]]. Useful for development purposes or to launch the server in a specified port
+The CLI will also write out `.dendron.*` [[metadata files|dendron.ref.layout#file-tree]] in the workspace root just the same as the Dendron plugin.
+```
+dendron-cli launchEngineServer --wsRoot ~/Dendron/ --vaults ~/Dendron/vault --port 3005
+```
+## Publishing Commands
+### buildSite (DEPRECATED)
+Build dendron site.
+```
+dendron-cli buildSite
+build notes for publication
+Options:
+  --version      Show version number                                   [boolean]
+  --help         Show help                                             [boolean]
+  --wsRoot       location of workspace                                [required]
+  --vault        location of vault                                    [required]
+  --writeStubs   writeStubs                                      [default: true]
+  --incremental  use rsync to only copy files that changed
+                                                      [boolean] [default: false]
+  --dryRun       don't actually build                 [boolean] [default: false]
+```
+- eg
+```
+dendron-cli buildSite --wsRoot . --vault ./vault
+```
+### publishNotes (DEPRECATED)
+Publish a dendron site
+```
+dendron-cli publishNotes
+Build, commit, and push your notes for publication
+Options:
+  --version         Show version number                                [boolean]
+  --help            Show help                                          [boolean]
+  --wsRoot          location of workspace                             [required]
+  --vault           location of vault                                 [required]
+  --writeStubs      writeStubs                                   [default: true]
+  --incremental     use rsync to only copy files that changed
+                                                      [boolean] [default: false]
+  --dryRun          don't actually build              [boolean] [default: false]
+  --noPush          don't push the result                              [boolean]
+  --publishRepoDir  repo to publish from. default is same as `wsRoot`
+```
+- eg:
+```
+dendron-cli publishNotes  --wsRoot . --vault ./vault
+```
+### buildSiteV2
+```bash
+dendron-cli buildSiteV2
+build notes for publication using 11ty
+Options:
+  --version         Show version number                                [boolean]
+  --help            Show help                                          [boolean]
+  --wsRoot          location of workspace                             [required]
+  --enginePort      If set, connecto to running engine. If not set, create new
+                    instance of Dendron Engine
+  --serve           serve over local http server      [boolean] [default: false]
+  --stage           serve over local http server
+                                       [choices: "dev", "prod"] [default: "dev"]
+  --servePort       port to serve over                         [default: "8080"]
+  --output          if set, override output from config.yml             [string]
+  --custom11tyPath  if set, path to custom 11ty installation            [string]
+```
+#### Connect to Open Workspace
+Normally, this command will spawn a new Dendron Engine that indexes your notes before building them for publication. You can skip this initial indexing if you have a current Dendron workspace running.
+In that case, the CLI can connect to the current engine instead of starting a new one using the following command.
+```bash
+cd {root/of/workspace}
+# .dendron.port has the port of the current running workspace
+npx dendron-cli buildSiteV2 --wsRoot . --stage dev --serve --enginePort `cat .dendron.port`
+```
+## Pod Commands
+- NOTE: you can find pod ids in the [[pods|dendron.topic.pod]] page. Just add a `.import|.export` to the end of the id (eg. `dendron.pod.json.import`)
+### Export Pod
+- export a pod
+- eg: Export notes to JSONPod
+```
+dendron-cli exportPod --podId dendron.json --wsRoot .
+```
+### Import Pod
+- eg: Import notes from FilePod
+```
+dendron-cli importPod --podId dendron.markdown --vault "/Users/kevinlin/Dendron-es/vault" --podsDir /Users/kevinlin/Dendron-es/pods
+```
+### Publish Pod
+- eg: Publish a note as regular markdown
+```bash
+dendron-cli publishPod --wsRoot . --vault ./vault --podId dendron.markdown --noteByName dendron
+```

Added: vault/dendron.topic.commands.md

Files changed (1) hide show

vault/dendron.topic.commands.md +432 -0

vault/dendron.topic.commands.md ADDED Viewed

@@ -0,0 +1,432 @@
+---
+id: eea2b078-1acc-4071-a14e-18299fc28f47
+title: Commands
+desc: ''
+updated: 1615240879684
+created: 1595261816971
+---
+---
+## Lookup
+### Contribute
+- shortcuts: none
+Become an environmentalist and keep Dendron sustainable
+ This command takes you to Dendron's [Environmentalist](https://accounts.dendron.so/account/subscribe) plans.
+Environmentalists are users that can support Dendron financially through a monthly contribution. Environmentalist get access to insider builds, priority support, and access to exclusive dev channels.
+---
+## Notes
+### Create Daily Journal Note
+- shortcuts:
+  - key: `ctrl+shift+i`
+  - mac: `cmd+shift+i`
+  - when: `editorFocus`
+Create a global journal note
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.daily.gif)
+### Copy Note Link
+- shortcuts:
+  - key: `ctrl+shift+c`
+  - mac: `cmd+shift+c`
+  - when: `editorFocus`
+Copy wiki link to note. The title of the note will be applied as the note alias. If you highlighter a header, dendron will create a relative link to the header with the alias set to the header value.
+If you use this command in a [[multi vault|dendron.topic.multi-vault]] workspace, Dendron will create a [[cross vault link|dendron.topic.links#cross-vault-links]] to the note in question.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command.copy-link.gif)
+### Copy Note Ref
+- shortcuts:
+  - key: `ctrl+shift+r`
+  - mac: `cmd+shift+r`
+  - when: `editorFocus`
+Copies a reference to the current open document
+ Lets you quickly create a [[note reference|dendron.topic.refs]] to the current note.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-note.gif)
+If you have a header selected while running this command, it will copy the note ref with the selected header to the next note ref
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/refs.copy-selection.gif)
+If you use this command in a [[multi vault|dendron.topic.multi-vault]] workspace, Dendron will create a [[cross vault link|dendron.topic.links#cross-vault-links]] to the note in question.
+### Delete Node
+- shortcuts:
+  - key: `ctrl+shift+d`
+  - mac: `cmd+shift+d`
+Delete a note or schema
+### Move Note
+Move a note. Also includes option to move a note between vaults
+### Paste Link
+Transform URL in clipboard to nicely formatted markdown link
+### Rename Note
+- shortcuts: none
+Rename a note and all backlinks
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/command-rename.gif)
+### Show Preview
+- shortcuts:
+  - windows: `windows+ctrl+p`
+  - mac: `cmd+ctrl+p`
+Show Markdown Preview
+* * *
+## Navigation
+### Lookup
+- shortcuts:
+  - mac: `cmd+L`
+  - key: `ctrl+l`
+Initiate note lookup
+![[dendron.topic.lookup]]
+### Lookup (Journal Note)
+- shortcuts:
+  - key: `ctrl+shift+j`
+  - mac: `cmd+shift+j`
+  - args: `{'noteType': 'journal'}`
+Initiate note lookup with journal note pre-selected
+### Lookup (Scratch Note)
+- shortcuts:
+  - key: `ctrl+shift+s`
+  - mac: `cmd+shift+s`
+  - args: `{'noteType': 'scratch', 'selectionType': 'selection2link'}`
+Initiate note lookup with scratch note pre-selected
+### Lookup Schema
+- shortcuts:
+  - mac: `cmd+shift+L`
+  - key: `ctrl+shift+l`
+Initiate schema lookup
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-lookup.gif)
+### Open Link
+- shortcuts: none
+Open link to external file (eg. pdf, .mov, etc) use system default
+<a href="https://www.loom.com/share/01250485e20a4cdca2a053dd6047ac68"><img src="https://cdn.loom.com/sessions/thumbnails/01250485e20a4cdca2a053dd6047ac68-with-play.gif"> </a>
+* * *
+## Hierarchies
+### Reload Index
+- shortcuts: none
+Reload the index. Necessary for Dendron to pick up on schema changes.
+### Archive Hierarchy
+- shortcuts: none
+Move current note and all children under the `archive` hierarchy
+ This is a convenience method around `Refactor Hierarchy` for the case of archiving hierarchies you are no longer using. For example, if you were currently at `pro.foo`, running `Archive Hierarchy` would be equivalent to running `Refactor Hierarchy` with the following arguments:
+- matcher: `pro.foo`
+- replacement:  `archive.pro.foo`
+<a href="https://www.loom.com/share/9698d5a4451b49d8b107f3ff67d97877">  <img style="" src="https://cdn.loom.com/sessions/thumbnails/9698d5a4451b49d8b107f3ff67d97877-with-play.gif"> </a>
+### Refactor Hierarchy
+- shortcuts: none
+Update hierarchy using regex
+ Like `Rename Note` but works on an entire hierarchy of notes. This command takes two arguments:
+- matcher: regex that matches text you want to capture for replacement
+- replacer: regex that represents text you want to use as replacement
+After running the command, you will be taken to a preview that shows all files that will be affected. You will be given an option in a dropdown to either proceed with the refactor or cancel the operation.
+- NOTE: Dendron will warn you if refactoring will overwrite existing files. You will need to either change your `replacer` or move the affected files before Dendron will perform a refactor
+Refactor Hierarchy is
+<https://discordapp.com/channels/717965437182410783/743194856788328497/743195382795993291>
+<a href="https://www.loom.com/share/11d90a86fd1348a5a504406b52d79f85"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/11d90a86fd1348a5a504406b52d79f85-with-play.gif"> </a>
+### Go Up
+- shortcuts:
+  - mac: `cmd+shift+up`
+  - key: `ctrl+shift+up`
+  - when: `editorFocus`
+Go to closet non-stub parent of the currently open note
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-up.gif)
+### Go Next Sibling
+- shortcuts:
+  - key: `ctrl+shift+]`
+  - when: `editorFocus`
+Go to the next sibling
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-sibling.gif)
+### Go Previous Sibling
+- shortcuts:
+  - key: `ctrl+shift+[`
+  - when: `editorFocus`
+Go to the previous sibling
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-sibling.gif)
+### Go Down
+- shortcuts:
+  - mac: `cmd+shift+down`
+  - key: `ctrl+shift+down`
+  - when: `editorFocus`
+Go down the hierarchy
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/hierarchy.go-down.gif)
+* * *
+## Workspace
+### Vault Add
+- shortcuts: none
+Add a new vault
+When you add a vault, you can choose between adding a local vault or a remote vault. A local vault is a folder in your file system and a remote vault is a git repository. If you choose a remote vault, you can choose from a vault from the registry or enter a custom git url.
+We currently have two vaults in the registry: `dendron.so` and `aws.dendron.so`. These correspond to the notes backing https://dendron.so/ and https://aws.dendron.so/ respectively.
+Note that when you add a remote vault, the url can also point to a remote workspace. In that case, dendron will inspect the `dendron.yml` to get a list of all vaults within the workspace and add all vaults from inside the workspace.
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/b4171372f9794dd7be609c043f343fa3" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+### Vault Remove
+- shortcuts: none
+Remove a vault
+Remove a vault from your workspace. Note that the underlying files wil **not** be deleted - the vault will lose its association with your workspace.
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/307effc22b8d4c59a32933529a8393e1" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+### Initialize Workspace
+- shortcuts: none
+Create a new workspace
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workspace-init.gif)
+### Change Workspace
+- shortcuts: none
+Change into existing workspace
+### Snapshot Vault
+- shortcuts: none
+Create a snapshot of your vault
+ Takes a snapshot of your entire vault, including assets. This command will ignore version control folders like .git when making a snapshot.
+Snapshots are saved under {workspace}/snapshots/{timestamp}
+### Restore Vault
+- shortcuts: none
+Restore your vault from a snapshot
+ Restores your vault based on a snapshot. When restoring, it will over-write any notes that have the same name as notes in the snapshot. It will ignore version control directories like .git when restoring your vault
+### Show Help
+- shortcuts: none
+Dendron will open your current browser to the [[cheatsheet|dendron.cheatsheet]] page.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.help.gif)
+### Configure (yaml)
+- shortcuts: none
+Modify Dendron Config as raw YAML
+### Configure
+- shortcuts: none
+Modify Dendron Config using Dendron UI
+ <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/5b6689eb76344fbb814a3d4405ef62b8" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+* * *
+## Pods
+### Build Pod
+- shortcuts: none
+Build your notes for export. Currently, only export to github pages is supported.
+### Configure Pod
+- shortcuts: none
+Update your pod configuration
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pods.configure.gif)
+### Import Pod
+- shortcuts: none
+Import notes from an external data source. Currently, only the local file system is supported
+### Export Pod
+- shortcuts: none
+Export notes to an external data source. Currently only JSON is supported.
+<a href="https://www.loom.com/share/d49e5f4155af485cadc9cd810b6cab28"> <img src="https://cdn.loom.com/sessions/thumbnails/d49e5f4155af485cadc9cd810b6cab28-with-play.gif"> </a>
+### Publish Pod
+- shortcuts: none
+Publish your note to a different format/location
+### Copy Note URL
+- shortcuts:
+  - mac: `cmd+shift+u`
+  - windows: `ctrl+shift+u`
+Get URL of current note from published site
+If you highlight a header, will copy the url with the header set as the anchor
+The url is taken from the [[siteUrl|dendron.topic.publishing.configuration#siteurl]] property.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.copy-url.gif)
+* * *
+## Publishing
+### Publish
+- shortcuts: none
+Build, commit and publish your notes with a single command
+- NOTE: this is mean for v1 publishing. V2 publishing currently does not have a publish command.
+<a href="https://www.loom.com/share/c58edf543e234a8fa164095237579ccc"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/c58edf543e234a8fa164095237579ccc-with-play.gif"> </a>
+### Site Build
+- shortcuts: none
+Build your notes using publishing v2
+This command works by running `dendron-cli` in the background.
+### Site Preview
+- shortcuts: none
+Preview your notes on localhost using publishing v2.
+This command works by running `dendron-cli` in the background.
+* * *
+## Dev
+### Doctor
+- shortcuts: none
+Auto fix issues with frontmatter
+ This makes sure your workspace is up to date. It will execute the following actions:
+- add ids and titles to the frontmatter of all notes that are missing it
+- setup a `docs` folder if it doesn't exist. Required if you want to [[publish|dendron.topic.publishing]] your notes
+<a href="https://www.loom.com/share/bd045f708f8e474193de8e3de0dc820f"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/bd045f708f8e474193de8e3de0dc820f-with-play.gif"> </a>
+### Dump State
+- shortcuts: none
+Dump internal state of Dendron inside logs
+ This is useful when diagnosing issues in Dendron
+### Dendron:Dev: Open Logs
+- shortcuts: none
+Open Dendron logs for current session
+### Dendron:Dev: Diagnostics Report
+- shortcuts: none
+Copy last 3000 lines of all logs and config to clipboard. Use when submitting an issue to Dendron

Added: vault/dendron.topic.config.md

Files changed (1) hide show

vault/dendron.topic.config.md +226 -0

vault/dendron.topic.config.md ADDED Viewed

@@ -0,0 +1,226 @@
+---
+id: eea2b078-1acc-4071-a14e-18299fc28f48
+title: Config
+desc: ''
+updated: 1615241271952
+created: 1595261816971
+---
+Dendron configuration currently lives in two places:
+- Dendron config: `dendron.yml` located at the root of your workspace
+- VSCode config: `dendron.code-workspace`: the vscode workspace file
+## Dendron Config
+### generateChangelog
+- default: false
+- status: 🚧
+Turn on to enable [[changelogs|dendron.topic.publishing.changelogs]]
+### lookupConfirmVaultOnCreate
+With this set, you can pick the vault for new notes.
+### mermaid
+- default: false
+Turn on to enable [[mermaid support|dendron.topic.markdown#diagrams]]
+### useContainers
+- default: false
+Turn on to enable [remark-container support](https://github.com/Nevenall/remark-containers)
+### useFMTitle
+When set to true, use frontmatter as title when publishing and in the preview.
+### useNoteTitleForLink
+If true, use the note title when displaying naked links
+- NOTE: this is not yet fully supported for multi-vault. specifically, cross vault links are not yet supported
+### usePrettyRefs
+- default: true
+If set to false, don't use [[pretty refs|dendron.ref.terms#pretty-ref]]
+### vaults
+Tracks [[vaults|dendron.concepts#vaults]] for the workspace. You shouldn't have to manually edit this value. This is updated automatically when you first initialize a workspace and when you add or remove vaults to your workspace.
+#### Vault properties:
+##### fsPath
+- file path to vault
+##### name
+- default: last component of `fsPath`
+vault name
+##### visibility?
+- choices: "private|public"
+If set to private, notes in this vault will not be published regardless of any other configuration. This takes precedences over everything.
+##### remote?
+- added property for [[remote vaults|dendron.concepts#remote-vault]]
+- properties
+    - type: currently only `git` is supported (in the future, we might add additional types)
+    - url: url to github repo
+#### Local Vault Example
+```yml
+vaults:
+    - fsPath: vault
+```
+#### Remote Vault Example
+```yml
+vaults:
+    -
+        fsPath: dendron-vault
+        remote:
+            type: git
+            url: 'git@github.com:kevinslin/dendron-vault.git'
+        name: dendron
+    -
+        fsPath: yc-vault
+        remote:
+            type: git
+            url: 'git@github.com:kevinslin/yc-vault.git'
+        name: yc
+```
+## VSCode Config
+### dendron.dailyJournalDomain
+- type: string
+- default: daily
+domain where daily journals are kept
+### dendron.defaultJournalName
+- type: string
+- default: journal
+name used for journal notes
+### dendron.defaultJournalDateFormat
+- type: string
+- default: y.MM.dd
+Date format used for journal notes. Use [luxon style formatting](https://moment.github.io/luxon/docs/manual/formatting.html)
+### dendron.defaultJournalAddBehavior
+- type: string
+- default: childOfDomain
+- options:  ['childOfDomain', 'childOfDomainNamespace', 'childOfCurrent', 'asOwnDomain']
+strategy for adding new journal notes
+### dendron.defaultScratchName
+- type: string
+- default: scratch
+Name used for scratch notes. Date format used for scratch notes. Use [luxon style formatting](https://moment.github.io/luxon/docs/manual/formatting.html)
+### dendron.defaultScratchDateFormat
+- type: string
+- default: y.MM.dd.HHmmss
+date format used for scratch notes
+### dendron.defaultScratchAddBehavior
+- type: string
+- default: asOwnDomain
+- options:  ['childOfDomain', 'childOfDomainNamespace', 'childOfCurrent', 'asOwnDomain']
+strategy for adding new scratch notes
+### dendron.defaultTimestampDecorationFormat:
+- default: DATETIME_MED
+- type: string
+- values (see description of values [here](https://moment.github.io/luxon/docs/manual/formatting.html))
+    * DATETIME_FULL
+    * DATETIME_FULL_WITH_SECONDS
+    * DATETIME_HUGE
+    * DATETIME_HUGE_WITH_SECONDS
+    * DATETIME_MED
+    * DATETIME_MED_WITH_SECONDS
+    * DATETIME_SHORT
+    * DATETIME_SHORT_WITH_SECONDS
+    * DATE_FULL
+    * DATE_HUGE
+    * DATE_MED
+    * DATE_MED_WITH_WEEKDAY
+    * DATE_SHORT
+    * TIME_24_SIMPLE
+    * TIME_24_WITH_LONG_OFFSET
+    * TIME_24_WITH_SECONDS
+    * TIME_24_WITH_SHORT_OFFSET
+    * TIME_SIMPLE
+    * TIME_WITH_LONG_OFFSET
+    * TIME_WITH_SECONDS
+    * TIME_WITH_SHORT_OFFSET
+Decide how human readable timestamp decoration is displayed
+### dendron.copyNoteUrlRoot
+- type: string
+- default: none
+override root url when getting note url
+### dendron.linkSelectAutoTitleBehavior
+- type: string
+- default: slug
+- options:  ['none', 'slug']
+Control title behavior when using selection2link with lookup
+### dendron.defaultLookupCreateBehavior
+- type: string
+- default: selectionExtract
+- options:  ['selection2link', 'selectionExtract']
+when creating a new note with selected text, define behavior for selected text
+### dendron.rootDir
+- type: string
+- default:
+location of dendron workspace
+### dendron.dendronDir
+- type: string
+- default:
+location of dendron configuration
+### dendron.logLevel
+- type: string
+- default: info
+- options:  ['debug', 'info', 'error']
+control verbosity of dendron logs
+### dendron.trace.server
+- type: string
+- default: messages
+- options:  ['off', 'messages', 'verbose']
+LSP log level
+### dendron.serverPort
+- type: number
+- default: none
+port for server. If not set, will be randomly generated at startup.

Added: vault/dendron.topic.exports.md

Files changed (1) hide show

vault/dendron.topic.exports.md +12 -0

vault/dendron.topic.exports.md ADDED Viewed

@@ -0,0 +1,12 @@
+---
+id: 1c1a3eac-9937-4e76-b086-bbb1d911517b
+title: Exports
+desc: ''
+updated: 1599574474272
+created: 1599574474272
+stub: false
+---
+The Dendron Markdown Preview supports HTML, PDF, and export to many different options. You can see [here](https://shd101wyy.github.io/markdown-preview-enhanced/#/html) for the docs.
+If you would like to export to additional formats our sources, you will (soon) be able to use  [[Dendron Export Pods|dendron.topic.pod]] to export your notes anywhere notes can be exported to!

Added: vault/dendron.topic.extensions.md

Files changed (1) hide show

vault/dendron.topic.extensions.md +31 -0

vault/dendron.topic.extensions.md ADDED Viewed

@@ -0,0 +1,31 @@
+---
+id: 301e4129-6933-4be7-a4bd-8125171360d8
+title: Extensions
+desc: ''
+updated: 1609795837739
+created: 1596643515473
+stub: false
+---
+## Bundled
+Since Dendron runs on top of VSCode, it means that you also have access to thousands of extensions to customize Dendron exactly how you like it. By default, Dendron will initialize your first workspace with the following extensions and features.
+- [Dendron Markdown Links](https://marketplace.visualstudio.com/items?itemName=dendron.dendron-markdown-links)
+  - Graph View
+- [Dendron Markdown Shortcuts](https://marketplace.visualstudio.com/items?itemName=dendron.dendron-markdown-shortcuts)
+  - Quickly toggle bullet points
+  - Easily generate URLs
+  - Convert tabular data to tables
+- [Dendron Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=dendron.dendron-markdown-preview-enhanced)
+  - live markdown preview
+  - math
+  - sequence diagrams
+  - pandoc support
+  - code chunks
+- [Material Theme](https://marketplace.visualstudio.com/items?itemName=equinusocio.vsc-material-theme)
+  - beautiful colors built using the [Material design system](https://material.io/)
+- [Dendron Paste Image](https://marketplace.visualstudio.com/items?itemName=dendron.dendron-paste-image)
+  - easily add images from your clipboard to your markdown files
+((ref:[[dendron.guides.tips]]#other VSCode extensions:#other Browser Extensions))

Added: vault/dendron.topic.frontmatter.md

Files changed (1) hide show

vault/dendron.topic.frontmatter.md +67 -0

vault/dendron.topic.frontmatter.md ADDED Viewed

@@ -0,0 +1,67 @@
+---
+id: ffec2853-c0e0-4165-a368-339db12c8e4b
+title: Frontmatter
+desc: ''
+updated: 1614665377409
+created: 1595352354163
+stub: false
+---
+Frontmatter is [YAML](https://yaml.org/) that you can add to the front of your markdown file. It was first introduced by [jekyll](https://jekyllrb.com/docs/front-matter/) and is a convenient way of adding metadata to your plaintext documents.
+Dendron supports frontmatter. By default, we add the following keys to a new note created with Dendron:
+- id: a globally unique identifier for the note
+- title: your note title. used to label nodes in [[graph view|dendron.topic.graph-view]]
+- desc: optional description about your note. will show up in lookup results
+- updated: unix timestamp of when note was updated
+- created: unix timestamp of when note was created
+Frontmatter isn't required in Dendron and Dendron will happily index markdown files without frontmatter. Feel free to add your attributes. As long as it doesn't conflict with a Dendron builtin keyword, Dendron will leave it alone. In the future, we plan on adding a lot more functionality to the frontmatter you see in Dendron so stay tuned.
+# Reserved Keys
+Note that not all the keys are written out to the markdown file. Dendron merges the attributes from the markdown frontmatter to its own internal set of attributes.
+### id
+A globally unique identifier for the note.
+### title
+Your note title. used to label nodes in [[graph view|dendron.topic.graph-view]]
+### desc
+Optional description about your note. will show up in lookup results
+### updated
+Unix timestamp of when note was updated
+### created
+Unix timestamp of when note was created
+### parent
+Node parent
+### children
+Node children
+### uri
+Absolute filepath to the note
+### data
+this is reserved for internal use
+### custom
+this is reserved for internal use
+# Other keys
+((ref:[[dendron.topic.publishing.configuration]]#Note Configuration))

Added: vault/dendron.topic.graph-view.md

Files changed (1) hide show

vault/dendron.topic.graph-view.md +41 -0

vault/dendron.topic.graph-view.md ADDED Viewed

@@ -0,0 +1,41 @@
+---
+id: 587e6d62-3c5b-49b0-aedc-02f62f0448e6
+title: Graph View
+desc: ''
+updated: 1610908980098
+created: 1595120707814
+stub: false
+---
+Dendron provides support for graph view using a fork of the [markdown-links](https://marketplace.visualstudio.com/items?itemName=tchayen.markdown-links) extension.
+The Dendron graph view is generated using our hierarchical index. It also shows different relationships than most of the graph views you're probably used to.
+Instead of showing edges as links between nodes, Dendron edges are the hierarchical relationships between your notes. Think of it as a 20,000 foot view of the structure of your knowledge base.
+Note that this command is not optimized for performance and you might notice slowdowns if you have more than a few hundred notes. If you are running into performance issues, please upvote this [issue](https://github.com/dendronhq/dendron/issues/107) to prioritize the performance work!
+## Commands
+### Dendron: Show Note Graph
+Launch the command bar (see [link](https://www.dendron.so/notes/401c5889-20ae-4b3a-8468-269def4b4865.html#launch-the-command-bar) for info): `> Dendron: Show Note Graph`
+Show your note hierarchies visually in a graph.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/graph.show-notes.gif)
+### Dendron: Show Schema Graph
+Launch the command bar (see [link](https://www.dendron.so/notes/401c5889-20ae-4b3a-8468-269def4b4865.html#launch-the-command-bar) for info): `> Dendron: Show Schema Graph`
+Show your note schemas visually in a graph. Schemas will be labelled by their `title` attribute. If `title` is not set, default to its `id`.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/graphs.show-schema.gif)
+### Dendron: Sync Note Graph
+Updates the note graph with most recent changes
+### Dendron: Sync Schema Graph
+Updates the schema graph with most recent changes

Added: vault/dendron.topic.hierarchies.md

Files changed (1) hide show

vault/dendron.topic.hierarchies.md +106 -0

vault/dendron.topic.hierarchies.md ADDED Viewed

@@ -0,0 +1,106 @@
+---
+id: f3a41725-c5e5-4851-a6ed-5f541054d409
+title: Hierarchies
+desc: ''
+updated: 1595611213607
+created: 1595611213607
+stub: false
+---
+Within a vault, your notes are stored **hierarchically** as `.` delimited markdown files.
+Below is a hypothetical hierarchy for a file tree:
+```
+.
+└── project1/
+    ├── project1/designs/
+    │   └── project1/designs/promotion.png
+    ├── project1/paperwork/
+    │   └── project1/paperwork/legal.md
+    └── project1/tasks/
+        ├── project1/tasks/task1.md
+        └── project1/tasks/task2.md
+```
+The same hierarchy in Dendron would look like the following:
+```
+.
+├── project1.md
+├── project1.designs.md
+├── project1.designs.promotion.md
+├── project1.paperwork.md
+├── project1.paperwork.legal.md
+├── project1.tasks.md
+├── project1.tasks.task1.md
+└── project1.tasks.task2.md
+```
+## Concepts
+In the following concepts, we will be using the following file tree
+((ref:[[dendron.ref.layout]]#File Tree,1:#Additional Folders))
+### Root
+Every vault has a root. This is the `root.md`.
+### Domain
+The domain is the root of a specific hierarchy. In our example vault, we have one domain - `dendron`.
+## Why Hierarchies?
+Dendron is built around hierarchies and the axiom that a canonical hierarichal representation of notes is one of the most effective ways of managing large numbers of notes. You can read more about the thoughts behind this [here](https://kevinslin.com/organizing/its_not_you_its_your_knowledge_base/).
+## What's with the `.`'s?
+1. It allows each **file** to also be a **folder**. This means your notes can have data but also contain other notes.
+2. It makes it much easier to perform certain refactoring operations. For example, say you had the following [[schema|dendron.topic.schema]]
+   ```yml
+   - id: a-parent
+   children:
+       - child-a
+       - child-b
+   - id: child-a
+   - id: child-b
+   ```
+   Lets say you wanted to make `child-b` a child of `child-a`
+   ```yml
+   - id: a-parent
+   children:
+       - child-a
+   - id: child-a
+   children:
+       - child-b
+   - id: child-b
+   ```
+    With the classical folder hierarchy, you would need to turn `child-a` into a folder and then create a custom file to hold the content from the original `child-a`
+   ```
+   .
+   └── a-parent
+       └── child-a
+           ├── child-a-note
+           └── child-b
+   ```
+    With the `.` delimited hierarchy, this becomes a simple rename operation
+   ```
+   .
+   ├── a-parent.child-a
+   └── a-parent.child-a.child-b
+   ```
+3. It allows us to create [[stubs|dendron.topic.schema]] for parts of the hierarchy that don't exist and not clutter our file system with empty folders. With the classical folder hierarchy
+   ```
+   .
+   └── a-parent
+       └── child-a
+           └── grandchild-a
+               └── great-grandchild-a.md
+   ```
+   With the `.` delimited hierarchy
+   ```
+   .
+   └── a-parent.child-a.grandchild-a.great-grandchild-a.md
+   ```

Added: vault/dendron.topic.images.md

Files changed (1) hide show

vault/dendron.topic.images.md +25 -0

vault/dendron.topic.images.md ADDED Viewed

@@ -0,0 +1,25 @@
+---
+id: a91fd8da-6895-49fe-8164-a17acd8d9a17
+title: Images
+desc: ''
+updated: 1595562035825
+created: 1595562035825
+stub: false
+---
+## Copy & Paste
+Dendron automatically inserts images in your clipboard using the `> Paste Image` command. The image is saved to `${currentFileDir}/assets` by default.
+<a href="https://www.loom.com/share/e1f6d207a1134f42b7a1a7750658acec">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/e1f6d207a1134f42b7a1a7750658acec-with-play.gif"> </a>
+</a>
+## Inserting Saved Images
+An easy way to insert an image which is saved locally to your markdown note is to do the following:
+- Copy / save the image in your `assets/images` folder located in your vault,
+- In Dendron navigate to the note where you wish to input the image(s), and type:
+- `![Image_Description](assets/images/File_Name.png)`
+  - Be sure to replace `Image_Description` and `File_Name.png` with the description of the image and the actual filename

Added: vault/dendron.topic.imports.md

Files changed (1) hide show

vault/dendron.topic.imports.md +18 -0

vault/dendron.topic.imports.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+id: 3a9c996b-60d7-4ed9-85bf-cdf3243e9693
+title: Imports
+desc: ''
+updated: 1599596299357
+created: 1599596299357
+stub: false
+---
+## Foam
+Dendron should be compatible with foam notes without any changes.
+Few things to note though: foam adds "link reference definitions" to the bottom of each file, you might want to remove them since they are not needed in dendron. Also to be able to benefit from dendron hierarchies, you might want to go through each note and think how you want to place them into the hierarchy.
+## Roam
+## Obsidian

Added: vault/dendron.topic.keybindings.md

Files changed (1) hide show

vault/dendron.topic.keybindings.md +30 -0

vault/dendron.topic.keybindings.md ADDED Viewed

@@ -0,0 +1,30 @@
+---
+id: c8e99b84-8a5a-42d3-838d-3d5cdebf32e5
+title: Keybindings
+desc: ''
+updated: 1597950074331
+created: 1597950074331
+stub: false
+---
+Dendron uses VSCode [keybinding](https://code.visualstudio.com/docs/getstarted/keybindings) functionality to define its own keybindings.
+To update your keybindings, open the command prompt and type `Open Keyboard Shortcuts`.
+<a href="https://www.loom.com/share/fec07d11a8d949dd98c9ce2ce0bda507">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/fec07d11a8d949dd98c9ce2ce0bda507-with-play.gif"> </a>
+If you prefer to work with JSON, you can use `Open Keyboard Shortcuts (JSON)`.
+You can read more about keybinding syntax [here](https://code.visualstudio.com/docs/getstarted/keybindings)
+# Tips
+### Add, Reset and Remove
+- Add: Every command in VSCode can be bound to a keybinding, even if it doesn't have one
+- Reset: If you want to go back to a default binding, reset it
+- Remove: If you don't use an existing binding, you can remove it
+<a href="https://www.loom.com/share/ec107e7c70f94070b9a4f52dd88b0899">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/ec107e7c70f94070b9a4f52dd88b0899-with-play.gif"> </a>

Added: vault/dendron.topic.links.md

Files changed (1) hide show

vault/dendron.topic.links.md +52 -0

vault/dendron.topic.links.md ADDED Viewed

@@ -0,0 +1,52 @@
+---
+id: 3472226a-ff3c-432d-bf5d-10926f39f6c2
+title: Links
+desc: ''
+updated: 1614639285945
+created: 1595003088839
+stub: false
+---
+Dendron supports multiple types of links and formats.
+- `[markdown links](./dendron.md)`
+- `[[wiki links]]`
+- `[[labelled|wiki links]]`
+- `![image links](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/logo-256.png)`
+- links to `[local files](assets/think.pdf)` (eg. pdfs, psds, etc)
+## Wiki Links
+Wiki links support **autocomplete**. To initiate:
+- create wikilink brackets and start typing
+- link to specific sections of notes using the `[[wiki link#header]]` syntax.
+  - NOTE: relative links will not go to the anchor if clicked on the preview, in that case, it becomes a normal link to the file
+  - NOTE2: don't work when exported through a pod
+- use the vscode [intellisense shortcut](https://code.visualstudio.com/docs/editor/intellisense#_key-bindings) to trigger the autocomplete
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/links-autocomplete.gif)
+## Backlinks
+Dendron has a backlink panel which shows all notes with links to the current note.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/links.backlink.jpg)
+## Other Links
+For links to a file format Dendron does not support, you can use the highlight the link and use `> Dendron: Open Link` to open the file using your operating system default for that file. This also applies to opening paths to folders.
+<a href="https://www.loom.com/share/01250485e20a4cdca2a053dd6047ac68"><img src="https://cdn.loom.com/sessions/thumbnails/01250485e20a4cdca2a053dd6047ac68-with-play.gif"> </a>
+## Cross Vault Links
+Cross vault links are a way of exactly specifying a note in a [[multi vault|dendron.topic.multi-vault]] workspace. You can turn a regular link into a cross vault link by adding `dendron://$vaultName/` prefix where `$vaultName` is the [[name|dendron.topic.config#name]] of your vault.
+Some examples:
+- regular wiki link: `[[dendron://vault/foo]]`
+- wiki link with alias: `[[Foo Note|dendron://vault/foo]]`
+- relative link: `[[Foo Note|dendron://vault/foo#header1]]`
+You can also use cross vault links for [[note references|dendron.topic.refs]].
+- note ref: `![[dendron://vault/foo]]`

Added: vault/dendron.topic.liquid.md

Files changed (1) hide show

vault/dendron.topic.liquid.md +20 -0

vault/dendron.topic.liquid.md ADDED Viewed

@@ -0,0 +1,20 @@
+---
+id: 1693cee1-3d1d-45b3-a1d2-62a10010ea35
+title: Liquid
+desc: ''
+updated: 1596394978287
+created: 1596394978287
+stub: false
+---
+You can publish your Dendron notes using Jekyll which has its own templating language called [liquid](https://jekyllrb.com/docs/liquid/). Because of this, published Dendron notes have access to all the templating features of liquid.
+Note that the templating features won't appear on regular markdown notes but will be rendered when you publish your notes.
+## Variables
+You can use variables defined in the frontmatter inside your page: {{page.created}}.
+## Filters
+You can use filters to transform text. {{ "This title will be modified" | slugify }}

Added: vault/dendron.topic.lookup.create.md

Files changed (1) hide show

vault/dendron.topic.lookup.create.md +33 -0

vault/dendron.topic.lookup.create.md ADDED Viewed

@@ -0,0 +1,33 @@
+---
+id: 0e57f8d1-e501-49db-974c-01eb64c20c22
+title: Creating Notes
+desc: ''
+updated: 1608752992139
+created: 1608494562268
+---
+## Summary
+While we call it the `Lookup Bar`, you can also use it to create notes that don't exist. When you lookup for a note that hasn't been created, Dendron will create it for you.
+To try it yourself, bring up the lookup bar. Type `hello` and hit `Enter`.
+## Creating Special Notes
+Dendron has builtin notion for certain types of notes with [[pre-defined hierarchies|dendron.topic.special-notes]]. These notes can be created by toggling the corresponding **note button**  on the lookup menu or by using the respective builtin shortcuts.
+- values:
+  - none (default): create a regular note
+  - journal: create a journal note (cmd/ctrl + shift + j)
+  - scratch: create a scratch note (cmd/ctrl + shift + s)
+## Creating Notes with a Selection
+If you have text highlighted while creating a new note with a lookup, the new note will be created using the text selected. How the text will be used depends on  the `dendron.defaultLookupCreateBehavior` setting.
+- values:
+  - selectionExtract (default): create new note with text from the old note. remove text from the old note
+  - selection2link: create new empty note and turn selection into a link referencing the old note
+<a href="https://www.loom.com/share/61d754c1dca84b99b2786b2f89473566">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/61d754c1dca84b99b2786b2f89473566-with-play.gif"> </a>

Added: vault/dendron.topic.lookup.delete.md

Files changed (1) hide show

vault/dendron.topic.lookup.delete.md +9 -0

vault/dendron.topic.lookup.delete.md ADDED Viewed

@@ -0,0 +1,9 @@
+---
+id: a6f1d6c7-91f3-4c14-9b89-9e66b6276f70
+title: Deleting Notes
+desc: ''
+updated: 1608494857196
+created: 1608494673903
+---
+To delete `dendron.lookup.hello`, use the `Cmd+Shift+D` shortcut on the note that you want to delete. Alternatively, you can also launch the `Command Bar` and type `Dendron: Delete Node`

Added: vault/dendron.topic.lookup.find.md

Files changed (1) hide show

vault/dendron.topic.lookup.find.md +17 -0

vault/dendron.topic.lookup.find.md ADDED Viewed

@@ -0,0 +1,17 @@
+---
+id: 84a0366a-eab5-4862-9bef-360f92a196dc
+title: Finding Notes
+desc: ''
+updated: 1608494862002
+created: 1608494616703
+---
+Below is an example of a simple two level hierarchy with notes on various [command line interface](https://en.wikipedia.org/wiki/Command-line_interface) commands. Use `Cmd+L` (we are going to use mac keybindings for this tutorial) to bring up the lookup and try some of the following queries.
+```
+- cli.tar
+- cli.curl
+- cli.dig
+```
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup-cli.gif)

Added: vault/dendron.topic.lookup.keybindings.md

Files changed (1) hide show

vault/dendron.topic.lookup.keybindings.md +25 -0

vault/dendron.topic.lookup.keybindings.md ADDED Viewed

@@ -0,0 +1,25 @@
+---
+id: 66d734d2-07bd-4ac6-be0b-a38b55bc1099
+title: Keybindings
+desc: ''
+updated: 1608494660278
+created: 1608494646816
+---
+You can trigger specific lookups using custom key bindings. For example, The following keybinding will trigger lookup set to creating a journal note and turning a selection into a link.
+((ref:[[dendron.topic.keybindings]]#keybindings,1))
+```json
+{
+"command": "dendron.lookup",
+"key": "cmd+k j",
+    "args": {
+        "noteType": "journal",
+        "selectionType": "selection2link"
+    }
+}
+```
+<a href="https://www.loom.com/share/1e6b39a93b7245e4b13310f7c06d972f">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/1e6b39a93b7245e4b13310f7c06d972f-with-play.gif"> </a>

Added: vault/dendron.topic.lookup.md

Files changed (1) hide show

vault/dendron.topic.lookup.md +12 -0

vault/dendron.topic.lookup.md ADDED Viewed

@@ -0,0 +1,12 @@
+---
+id: a7c3a810-28c8-4b47-96a6-8156b1524af3
+title: Lookup
+desc: ''
+updated: 1608495047845
+created: 1595952505038
+stub: false
+---
+To work with notes, Dendron uses  **lookups**. Lookups help you create, find, and organize your notes. You can watch the following video to see some of the things you can do with lookups.
+<a href="https://www.loom.com/share/a409a621763548d395e48c9d4380cbe7"><img style="" src="https://cdn.loom.com/sessions/thumbnails/a409a621763548d395e48c9d4380cbe7-1600813345789-with-play.gif"> </a>

Added: vault/dendron.topic.lookup.modifiers.md

Files changed (1) hide show

vault/dendron.topic.lookup.modifiers.md +117 -0

vault/dendron.topic.lookup.modifiers.md ADDED Viewed

@@ -0,0 +1,117 @@
+---
+id: ad270a7d-2aed-4273-8319-eb6536e38b29
+title: Modifiers
+desc: ''
+updated: 1608495043297
+created: 1604883459208
+---
+Modifiers allow you to update the behavior of lookup. You can trigger a modifier by clicking on the modifier icon or passing custom arguments to `dendron.lookup` when defining a custom keyboard shortcut.
+Modifiers are divided into 6 categories:
+- filter
+- selection
+- note
+- split
+- effect
+- other
+## filterType
+Filter notes that show up during lookup
+### directChildOnly
+By default, unless you are at the root of your workspace, dendron does a fuzzy search of all notes that match your current hierarchy prefix. This is useful to see your entire sub-tree in one glance but can be overwhelming if you have a lot of notes.
+Dendron's **directChildFilter** is a toggle that limits lookup to just the next level in the tree. This is useful for exploring your hierarchy one level at a time.
+- filter all notes that are not the direct children of the current note
+       ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.dchild.jpg)
+<a href="https://www.loom.com/share/45b49b53bf324aeebe387d2ba9515d94">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/45b49b53bf324aeebe387d2ba9515d94-with-play.gif"> </a>
+## selectionType
+Determines behavior of selected text when creating a new note via lookup
+### selectionExtract
+selection is extracted to newly created note (default)
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.selection.jpg)
+### selection2link
+selection is turned into a link to newly created note. note path is set to `{current-path}.{slug-of-selection}`
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.link.jpg)
+- a [slug](https://stackoverflow.com/questions/19335215/what-is-a-slug) is the human readable portion of an url
+  <a href="https://www.loom.com/share/abaa8083d93f4192aa480f1acef1a8b7">
+  <img style="" src="https://cdn.loom.com/sessions/thumbnails/abaa8083d93f4192aa480f1acef1a8b7-with-play.gif"> </a>
+- you can control this behavior using `dendron.linkSelectAutoTitleBehavior`
+((ref:[[dendron.topic.config]]#dendron.linkselectautotitlebehavior,1:#*))
+## noteType
+Modifies note path
+### journal
+Create a journal note
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.journal.jpg)
+### scratch
+create a scratch note
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.scratch.jpg)
+## splitType
+If set, open note in a new split
+### horizontal
+When opening a note via lookup, you can decide to have the note open in a horizontal split.This works when you're creating new notes or opening an existing note
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/lookup.splitType.jpg)
+<a href="https://www.loom.com/share/814bccbdec384cf094e040f1cc6eebe9">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/814bccbdec384cf094e040f1cc6eebe9-with-play.gif"> </a>
+## effectType
+Effects modify lookup in additional ways that are not covered by the other modification categories
+### multiSelect
+You can toggle multi-select within lookup. This lets you work with multiple notes at once. You can combine this with other modifiers like **splitType** and the **copyWikiLink** modifier.
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/913ff5490ba9445787ff1063be749658" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+### copyWikiLink
+Copy the results of a lookup as a wikilink.
+## Other Modifiers
+Dendron has a few additional modifiers that can only be set programatically
+### noConfirm
+If set, select first option from lookup without confirmation
+- type: boolean
+### value
+If set, have a custom value for lookup
+- type: string

Added: vault/dendron.topic.lookup.schemas.md

Files changed (1) hide show

vault/dendron.topic.lookup.schemas.md +29 -0

vault/dendron.topic.lookup.schemas.md ADDED Viewed

@@ -0,0 +1,29 @@
+---
+id: 60c03500-98e4-4a02-a31e-2702b4068a88
+title: Schemas
+desc: ''
+updated: 1608494693843
+created: 1608494693843
+---
+Dendron also provides lookup for [[schemas|dendron.topic.schema]]. To lookup a schema, use `> Dendron: Lookup Schema` or the `Cmd+Shift+L` (`Ctrl+Shift+L` on windows and linux) shortcut to bring up the schema lookup.
+### Finding Schemas
+The process for finding schemas using Dendron is the same as that for finding notes. One lookup to rule them all.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-lookup.gif)
+### Creating Schemas
+Just like with notes, if you enter the name of a schema that does not exist, Dendron will create it for you.
+Specifically, Dendron will create `{value}.schema.yml` in your vault. At this point, you are free to edit the schema. After you're satisfied with the result, you'll need to run [[> Dendron: Reload Index|dendron.topic.commands]] for it to take affect.
+- NOTE: if you get an error after running `Reload Index`, it is most likely because your YAML is malformed. You can paste it in [yaml lint](http://www.yamllint.com/) to check that you are using the correct yaml syntax.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-create.gif)
+### Deleting Schemas
+The process for deleting schemas using Dendron is identical to deleting notes.

Added: vault/dendron.topic.managed-publishing.md

Files changed (1) hide show

vault/dendron.topic.managed-publishing.md +12 -0

vault/dendron.topic.managed-publishing.md ADDED Viewed

@@ -0,0 +1,12 @@
+---
+id: a6b9c043-7713-48ea-b826-50d003e3e21f
+title: Managed Publishing (NEW)
+desc: ''
+updated: 1615161394505
+created: 1615160515751
+---
+This documentation goes over Dendron's managed hosting for publishing your notes
+## Related
+- [[2 - Managed Publishing RFC|dendron.rfc.2-managed-publishing]]

Added: vault/dendron.topic.managed-publishing.quickstart.md

Files changed (1) hide show

vault/dendron.topic.managed-publishing.quickstart.md +92 -0

vault/dendron.topic.managed-publishing.quickstart.md ADDED Viewed

@@ -0,0 +1,92 @@
+---
+id: 53de5c1e-b20c-4adc-ae48-e1659ecc6d13
+title: Quickstart
+desc: ''
+updated: 1615227076068
+created: 1613009015603
+---
+## Pre-requisites
+- a workspace pushed to Github
+    - if you don't have one ready, you can use the [starter template](https://github.com/dendronhq/workspace-sample)
+- create an account on https://app.dendron.so
+## Creating a site
+1. Go to https://app.dendron.so Create an account if you don't already have one.
+1. After you login, use "publish a site from Github"
+1. Enter the url of the repo that you want to publish
+1. Enter a [[personal access token|dendron.rfc.2-managed-publishing.ref.github-token]]
+When your site is ready, you should see the following screen
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Fullscreen_2_23_21__3_39_PM.jpg)
+### Fine Print
+- Dendron publishes your site at `{username}.dendron.wiki`
+### Limitations
+- NOTE: because managed publishing is in early access, the following restrictions currently apply
+<!-- -->
+- one site per account
+- ~~no custom domains~~
+- no multi-vault support
+## Deleting a Site
+1. Click `Site Settings` on the site widget
+2. Click `Delete`
+## Adding a custom domain via CNAME
+- this feature is limited to [[environmentalist|dendron.community.roles#environmentalist]]
+### Pre-prequisites
+- have a domain that you own and control the CNAME records for
+- have your github repo hooked up to dendron (see [[Creating a site|dendron.topic.managed-publishing.quickstart#creating-a-site]])
+### Steps
+1. Decide on a CNAME that you want to use. Lets call this YOUR_CNAME
+1. Email support@dendron.so with the subject: `CNAME Request: YOUR_CNAME`
+1. You'll get a response with a custom CNAME entry. Add that to your DNS (instructions to do this will depend on your registrar)
+    ```
+    _5e6e3c15a64565a3fbd9609d390e06d4.www.awschangelog.com. to _1fcefb9e363e5ebc64d8bc7ad6f31535.nfyddsqlcy.acm-validations.aws.
+    ```
+1. Update YOUR_CNAME to point to `hosting.dendron.wiki`
+1. Email support@dendron.so with the subject: `CNAME Request: YOUR_CNAME - UPDATED`
+1. You'll get a response from support@dendron.so that your account is now ready for custom domains
+1. Push to the repository that you have configured with managed publishing. Dendron will now connect your repository with your CNAME
+    - NOTE: the link to view the site will still be pointed to `$username.dendron.wiki`. You'll need to manually add your CNAME to see the changes
+<!-- 1. Go to `app.dendron.so` and update your published site with the CNAME -->
+### Limitations
+- custom domains with CNAMES doesn't work with apex domains (these are domains without a prefix - eg. foo.com is an apex domain, www.foo.com is not)
+    - if you are interested in using an apex domain, see the guide below
+## Add a custom domain via delegating name servers
+- this feature is limited to [[environmentalist|dendron.community.roles#environmentalist]]
+### Pre-prequisites
+- have a domain that you own and control the name server records for
+- have your github repo hooked up to dendron (see [[Creating a site|dendron.topic.managed-publishing.quickstart#creating-a-site]])
+### Steps
+1. Email support@dendron.so with the subject: `NS Request: YOUR_DOMAIN`
+    - example: `NS Request: kevin.xyz`
+1. You'll get a response with a custom NS entry. Add that to your DNS (instructions to do this will depend on your registrar)
+    - example response
+    ```
+    ns-1986.awsdns-48.co.uk.
+    ns-738.awsdns-28.net.
+    ns-1484.awsdns-52.org.
+    ns-298.awsdns-37.com.
+    ```
+1. Update your domain nameserver with the results
+    - WARNING: if you are currently serving traffic via the domain, this will cause your website to be temporarily un-availble
+    - NOTE: save your current name servers as backup for when you want to revert this process
+1. Email support@dendron.so with the subject: `NS Request: YOUR_DOMAIN - UPDATED`
+1. You'll get a response from support@dendron.so that your account is now ready for custom domains
+1. Push to the repository that you have configured with managed publishing. Dendron will now connect your repository with your CNAME
+    - NOTE: the link to view the site will still be pointed to `$username.dendron.wiki`. You'll need to manually add your CNAME to see the changes

Added: vault/dendron.topic.markdown.md

Files changed (1) hide show

vault/dendron.topic.markdown.md +321 -0

vault/dendron.topic.markdown.md ADDED Viewed

@@ -0,0 +1,321 @@
+---
+id: ba97866b-889f-4ac6-86e7-bb2d97f6e376
+title: Markdown
+desc: ''
+updated: 1614058664647
+created: 1598673110284
+---
+- Notice: all references of `MPE` in this guide is in reference to `Dendron Markdown Preview Enhanced`, the default markdown renderer of Dendron
+## Markdown Basics
+This article is a brief introduction to [GitHub Flavored Markdown writing](https://guides.github.com/features/mastering-markdown/).
+## What is Markdown?
+`Markdown` is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like `#` or `*`.
+## Syntax guide
+### Headers
+```markdown
+# This is an <h1> tag
+## This is an <h2> tag
+### This is an <h3> tag
+#### This is an <h4> tag
+##### This is an <h5> tag
+###### This is an <h6> tag
+```
+### Emphasis
+<!-- prettier-ignore -->
+```markdown
+*This text will be italic*
+_This will also be italic_
+**This text will be bold**
+__This will also be bold__
+_You **can** combine them_
+~~This text will be strikethrough~~
+```
+### Lists
+#### Unordered List
+```markdown
+- Item 1
+- Item 2
+  - Item 2a
+  - Item 2b
+```
+#### Ordered List
+```markdown
+1. Item 1
+1. Item 2
+1. Item 3
+   1. Item 3a
+   1. Item 3b
+```
+#### Definition List
+```markdown
+Item 1
+: Definition for Item 1
+Item 2
+~ Definition for Item 2
+~ Another definition for Item 2, with a [link](http://www.example.com)
+```
+### Images
+```markdown
+![GitHub Logo](/images/logo.png)
+Format: ![Alt Text](url)
+```
+### Links
+```markdown
+https://github.com - automatic!
+[GitHub](https://github.com)
+```
+### Blockquote
+```markdown
+As Kanye West said:
+> We're living the future so
+> the present is our past.
+```
+### Horizontal Rule
+```markdown
+Three or more...
+---
+Hyphens
+---
+Asterisks
+---
+Underscores
+```
+### Inline code
+```markdown
+I think you should use an
+`<addr>` element here instead.
+```
+### Fenced code block
+You can create fenced code blocks by placing triple backticks <code>\`\`\`</code> before and after the code block.
+#### Syntax Highlighting
+You can add an optional language identifier to enable syntax highlighting in your fenced code block.
+For example, to syntax highlight Ruby code:
+````
+```ruby
+require 'redcarpet'
+markdown = Redcarpet.new("Hello World!")
+puts markdown.to_html
+```
+````
+```ruby
+require 'redcarpet'
+markdown = Redcarpet.new("Hello World!")
+puts markdown.to_html
+```
+### Task lists
+```markdown
+- [x] list syntax required (any unordered or ordered list supported)
+- [x] this is a complete item
+- [ ] this is an incomplete item
+```
+## Extended Syntax
+These are non-standard markdown syntax used in Dendron. Everything here is both available in Dendron's preview as well as when publishing.
+### Tables
+You can create tables by assembling a list of words and dividing them with hyphens `-` (for the first row), and then separating each column with a pipe `|`:
+<!-- prettier-ignore -->
+```markdown
+First Header | Second Header
+------------ | -------------
+Content from cell 1 | Content from cell 2
+Content in the first column | Content in the second column
+```
+You can create a table from existing content using `> Markdown Shortcuts: Add Table` command.
+![](https://raw.githubusercontent.com/mdickin/vscode-markdown-shortcuts/master/media/demo/table_with_header.gif)
+### Abbreviation
+The HTML specification
+```markdown
+_[HTML]: Hyper Text Markup Language
+_[W3C]: World Wide Web Consortium
+The HTML specification
+is maintained by the W3C.
+```
+### Footnotes
+```markdown
+Content [^1]
+[^1]: Hi! This is a footnote
+```
+### Frontmatter Variable Substitution
+You can use variables defined in your note frontmatter inside your note. The syntax is `{{fm.VAR_NAME}}` where `VAR_NAME` is the name of your variable. The `fm` designates that you want to use a frontmatter variable.
+### Nunjuck Templates
+- status: EXPERIMENTAL
+You can use a limited set of [nunjucks](https://mozilla.github.io/nunjucks/) to customize your notes.
+To enable, you can set the following to true inside your `dendron.yml`.
+```yml
+useNunjucks: true
+```
+Once enabled, you'll have access to nunjucks specific constructs. You'll have the same variables available as during [[frontmatter variable substitution|dendron.topic.markdown#frontmatter-variable-substitution]]. Nunjucks templates also get access to the `fname` builtin variable which will be substituted with the filename of the current note.
+Below is an example of what you can do with nunjucks.
+- Raw Markdown
+```md
+## Variables
+- special variables: {{fname}}
+- special variable as link: [[{{fname}}]]
+- special variable as note ref: ![[{{fname}}#footer]]
+## Loops
+{% for item in fm.alist %}
+- Item: {{item}}
+  {% endfor %}
+## Footer
+This is some footer content
+```
+- Compiled
+![nunjucks example](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/topic.nunjucks.jpg)
+Nunjucks will work for both the preview and for publishing. It is still an experimental feature which means it might change in backwards in-compatible ways at any point.
+It currently also has the following limitations:
+- disables live preview of markdown (you'll need to refresh the markdown to see changes)
+- will throw an error if you currently have nunjucks like strings inside your notes `eg. {% %}`
+- will throw errors if you refer to an undefined variable `{{ foo }}`
+### Diagrams
+Dendron lets you create Diagrams using [mermaid](https://mermaid-js.github.io/mermaid/#/)
+Create a code block with mermaid support to use mermaid. The following block turns into the diagram below.
+<pre>
+```mermaid
+graph TD;
+    A-->B;
+    A-->C;
+    B-->D;
+    C-->D;
+```
+</pre>
+```mermaid
+graph TD;
+    A-->B;
+    A-->C;
+    B-->D;
+    C-->D;
+```
+- NOTE: in order to publish diagrams, you'll need to enable [[mermaid in the config|dendron.topic.config#mermaid-optional]]
+## VSCode Specific Commands
+### Markdown Smart Select
+This allows you to expand and shrink selections of markdown using a keyboard shortcut.
+- Expand: ⌃⇧⌘→
+- Shrink: ⌃⇧⌘←
+Selection applies to the following, and follows a traditional hierarchical pattern:
+- Headers
+- Lists
+- Block quotes
+- Fenced code blocks
+- Html code blocks
+- Paragraphs
+![preview](https://code.visualstudio.com/assets/updates/1_51/markdown-smart-select-demo.gif)
+> Image by Microsoft
+## Compatibility with CommonMark
+[CommonMark](https://commonmark.org/) is _a strongly defined, highly compatible specification of Markdown_
+When possible, Dendron will try to stay to `CommonMark` spec for syntax. That being said, many of the features we have (eg. block based note references) have no common mark equivalent which is why we've had to invent new syntax.
+You can use the [[markdown pod|dendron.topic.pod.builtin.markdown]] to migrate both individual notes and your entire vault to a CommonMark compatible format.
+## Other Resources
+- [Mastering Markdown](https://guides.github.com/features/mastering-markdown/)
+- [Daring Fireball: Markdown Basics](https://daringfireball.net/projects/markdown/basics)
+- [Markdown Guide](https://www.markdownguide.org/)
+## References
+The content of this page is derived from the following sources:
+1. [markdown preview enhanced docs](https://shd101wyy.github.io/markdown-preview-enhanced/#/markdown-basics) published under the [University of Illinois/NCSA Open Source License](https://github.com/shd101wyy/markdown-preview-enhanced/blob/master/LICENSE.md)
+2. [markdown shortcuts docs](https://marketplace.visualstudio.com/items?itemName=mdickin.markdown-shortcuts) published under the [MIT License](https://marketplace.visualstudio.com/items/mdickin.markdown-shortcuts/license)

Added: vault/dendron.topic.math.md

Files changed (1) hide show

vault/dendron.topic.math.md +38 -0

vault/dendron.topic.math.md ADDED Viewed

@@ -0,0 +1,38 @@
+---
+id: b1919663-cc48-4054-b0cf-4b26fe444907
+title: Math
+desc: ''
+updated: 1609036928368
+created: 1609036713270
+---
+Dendron uses [Katex](https://katex.org/) to render math.
+- Expressions inside `$...$`  will be rendered using inline format.
+- Expressions inside `$$...$$` will be rendered using block format.
+## Examples
+### Inline
+```
+$f(x) = sin(x)$
+```
+will render as
+$f(x) = sin(x)$
+### Block
+```
+$$
+f(x) = sin(x)
+$$
+```
+will render as
+$$
+f(x) = sin(x)
+$$

Added: vault/dendron.topic.md

Files changed (1) hide show

vault/dendron.topic.md +11 -0

vault/dendron.topic.md ADDED Viewed

@@ -0,0 +1,11 @@
+---
+id: 7a7af2fa-b9d0-4adc-81e6-f03186123539
+title: Topics
+desc: ''
+updated: 1595606002784
+created: 1595606002784
+stub: false
+nav_order: 4
+---

Added: vault/dendron.topic.ovsx.md

Files changed (1) hide show

vault/dendron.topic.ovsx.md +14 -0

vault/dendron.topic.ovsx.md ADDED Viewed

@@ -0,0 +1,14 @@
+---
+id: 9134f160-31a6-4ab0-a640-1fce466f9526
+title: Open VSX
+desc: ''
+updated: 1597006851049
+created: 1597006851049
+stub: false
+---
+Dendron and all its recommended extensions are published on the [open vsx](https://open-vsx.org/) registry. This means that Dendron can now be run on all VSCode compatible editors. The list of editors that Dendron **should** be compatible on is listed below:
+- [VSCodium](https://github.com/VSCodium/vscodium)
+- [Theia](https://theia-ide.org/)
+- [Code Server](https://github.com/cdr/code-server)

Added: vault/dendron.topic.pod.builtin.json.md

Files changed (1) hide show

vault/dendron.topic.pod.builtin.json.md +179 -0

vault/dendron.topic.pod.builtin.json.md ADDED Viewed

@@ -0,0 +1,179 @@
+---
+id: 28dfaaf8-4944-447c-be30-39c514a80bb0
+title: JSON Pod
+desc: ''
+updated: 1610233180012
+created: 1603306959022
+---
+## Summary
+- id: `dendron.json`
+- coverage
+  - ✅ import
+  - ✅ export
+  - ✅ publish
+### Import
+Imports a JSON file as Dendron notes
+- format:
+  - fname: name of note (without extension)
+  - body: contents of note
+- eg:
+```json
+[
+  {
+    "fname": "one",
+    "body": "one body"
+  }
+]
+```
+<a href="https://www.loom.com/share/375b64a6597346ec8e6be5ca35049194"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/375b64a6597346ec8e6be5ca35049194-with-play.gif"> </a>
+#### Export
+Below is sample output from an export of a vault with the following files
+```
+.
+└── vault
+    ├── root.md
+    ├── sample.child.md
+    └── sample.md
+```
+Exported JSON
+```json
+[
+  {
+    "id": "root",
+    "title": "root",
+    "desc": "",
+    "type": "note",
+    "updated": 1599430958377,
+    "created": 1599430958377,
+    "fname": "root",
+    "data": {},
+    "stub": false,
+    "custom": {},
+    "parent": null,
+    "children": [
+      "01d712a3-3676-403c-87d7-f3e7057ca43e",
+      "01d712a3-3676-403c-87d7-f3e7057ca43e"
+    ]
+  },
+  {
+    "id": "01d712a3-3676-403c-87d7-f3e7057ca43e",
+    "title": "Sample",
+    "desc": "",
+    "type": "note",
+    "updated": 1599430965554,
+    "created": 1599430965554,
+    "fname": "sample",
+    "data": {},
+    "stub": false,
+    "custom": {
+      "tags": [
+        "one",
+        "two",
+        "three"
+      ]
+    },
+    "parent": "root",
+    "children": [
+      "1d947d6e-39c4-4d31-9bec-749a467fc514"
+    ]
+  },
+  {
+    "id": "1d947d6e-39c4-4d31-9bec-749a467fc514",
+    "title": "Child",
+    "desc": "",
+    "type": "note",
+    "updated": 1599430969355,
+    "created": 1599430969355,
+    "fname": "sample.child",
+    "data": {},
+    "stub": false,
+    "custom": {
+      "customProp": "yellow",
+      "customStat": 5
+    },
+    "parent": "01d712a3-3676-403c-87d7-f3e7057ca43e",
+    "children": []
+  }
+]
+```
+Video example of exporting to JSON
+<a href="https://www.loom.com/share/d49e5f4155af485cadc9cd810b6cab28"> <img src="https://cdn.loom.com/sessions/thumbnails/d49e5f4155af485cadc9cd810b6cab28-with-play.gif"> </a>
+### Publish Pod
+Publish notre to JSON and copy into clipboard
+Sample output
+```json
+{
+    "id": "814f9a2c-f011-4852-a077-c887dd985656",
+    "title": "Two",
+    "type": "note",
+    "desc": "",
+    "links": [
+        {
+            "type": "wiki",
+            "from": {
+                "fname": "bar.two",
+                "id": "814f9a2c-f011-4852-a077-c887dd985656"
+            },
+            "original": "bar.two.child",
+            "value": "bar.two.child",
+            "alias": "bar.two.child",
+            "pos": {
+                "start": 23,
+                "end": 40
+            },
+            "to": {
+                "fname": "bar.two.child"
+            }
+        },
+        {
+            "type": "wiki",
+            "from": {
+                "fname": "bar.two",
+                "id": "814f9a2c-f011-4852-a077-c887dd985656"
+            },
+            "original": "bar.two.child",
+            "value": "bar.two.child",
+            "alias": "bar.two.child",
+            "pos": {
+                "start": 50,
+                "end": 67
+            },
+            "to": {
+                "fname": "bar.two.child"
+            }
+        }
+    ],
+    "fname": "bar.two",
+    "updated": 1603305706789,
+    "created": 1602872932440,
+    "parent": "93f6a3ad-2b0f-4843-9b65-961c65de9237",
+    "children": [
+        "8e19c23d-4335-4684-846e-ca7fed893b51"
+    ],
+    "body": "\n\n# Inner Note\n\n((ref: [[bar.two.child]]))\n((ref: [[bar.two.child]]))",
+    "data": {},
+    "custom": {},
+    "schema": {
+        "schemaId": "bar",
+        "moduleId": "bar"
+    }
+}
+```

Added: vault/dendron.topic.pod.builtin.markdown.md

Files changed (1) hide show

vault/dendron.topic.pod.builtin.markdown.md +71 -0

vault/dendron.topic.pod.builtin.markdown.md ADDED Viewed

@@ -0,0 +1,71 @@
+---
+id: 13c4a608-0a32-4c62-9c7e-2b7f9f2d18bf
+title: Markdown Pod
+desc: ''
+updated: 1610233214080
+created: 1603306941128
+---
+## Summary
+- id: `dendron.markdown`
+- coverage
+  - export
+  - ✅ import
+  - ✅ publish
+### Import
+Import markdown files stored locally.
+The pod finds all files from the `root`, and copies over the files into your vault, cleaning the file names to fit dendron's naming hierarchy. You can see an example below.
+- Original
+```
+.
+└── projects
+    ├── p1
+    │   ├── one.md
+    │   ├── two.md
+    │   └── one.pdf
+    └── p2
+        ├── three.md
+        ├── four.md
+        └── three.gif
+```
+- After Import
+```
+.
+└── vault
+    ├── assets
+    │   ├── one-{uuid}.pdf
+    │   └── three-{uuid}.gif
+    ├── projects.p1.md
+    ├── projects.p1.one.md
+    ├── projects.p1.two.md
+    ├── projects.p2.md
+    ├── projects.p2.three.md
+    └── projects.p2.four.md
+```
+Non-markdown files within a directory will be moved into the `assets` folder of your `vault`. A [uuid](https://en.wikipedia.org/wiki/Universally_unique_identifier) will be added to non-markdown file names to ensure it does not overwrite any existing files. A link of the original filenames will be made in the note that corresponds to the imported directory
+```md
+...
+# Imported Assets
+- [one.pdf](assets/one-c91d4cb3-1db8-4703-884f-c4f5f9a00734.pdf)
+```
+Note that all files starting with a `.` will be ignored during the import.
+#### Links
+If you are importing from tools like **Obsidian** that support wiki-links, Dendron will convert those wiki-links to Dendron's dot based format (eg. `[[project/p1]] -> [[project.p1]]`)
+### Publish
+Publish Dendron Markdown to regular markdown. Convert note references and dendron specific syntax to regular markdown.

Added: vault/dendron.topic.pod.builtin.md

Files changed (1) hide show

vault/dendron.topic.pod.builtin.md +20 -0

vault/dendron.topic.pod.builtin.md ADDED Viewed

@@ -0,0 +1,20 @@
+---
+id: 3e519113-5820-4a84-bef8-85103a7b296b
+title: Builtin Pods
+desc: ''
+updated: 1610233223346
+created: 1603306628504
+toc: true
+---
+## Summary
+Builtin pods are managed by Dendron and are available when you install Dendron. They can be used with either the `dendron-cli` or from within the Dendron extension to import/export/publish your notes from/to anywhere
+## JSON Pod
+![[dendron.topic.pod.builtin.json#summary:#*]]
+## Markdown Pod
+![[dendron.topic.pod.builtin.markdown#summary,1:#*]]

Added: vault/dendron.topic.pod.custom.md

Files changed (1) hide show

vault/dendron.topic.pod.custom.md +40 -0

vault/dendron.topic.pod.custom.md ADDED Viewed

@@ -0,0 +1,40 @@
+---
+id: 6322a2de-34fd-4c93-bcbe-d71c30e5f2b6
+title: Custom Pods
+desc: ''
+updated: 1614312977869
+created: 1603308868151
+---
+## Summary
+<!-- - STATUS: DRAFT
+- NOTE: this documentation is for future functionality. It is not currently implemented. Progress can be tracked in this [issue](https://github.com/dendronhq/dendron/issues/286). -->
+Custom pods can be developed by anyone as a `NodeJS` package and used after a user installs it in their workspace. They can be used with either the `dendron-cli` or from within the Dendron extension to import/export/publish your notes from/to anywhere
+- NOTE: at the current time, custom pods can only be run using `dendron-cli`. We're working on building them into the plugin within the next couple of weeks
+- NOTE: currently, only custom pods for **publishing** is supported. We're working on adding support for `import` and `export` pods
+## Quickstart (Using a custom pod)
+Run the following inside your Dendron workspace.
+### Install a Pod
+```bash
+cd {workspace}
+npm init -y
+npm install -g dendron-cli
+npm install --save {dendron-pod-package}
+```
+### Execute a Pod (CLI)
+```bash
+dendron-cli publishPod --wsRoot . --podId {podId} --podPkg {npmPkg} --podSource custom --config {podConfig}
+```
+## List of Custom Pods
+- [[Dev.to Pod|dendron.pro.devto-pod]]: publish notes to dev.to

Added: vault/dendron.topic.pod.dev.md

Files changed (1) hide show

vault/dendron.topic.pod.dev.md +161 -0

vault/dendron.topic.pod.dev.md ADDED Viewed

@@ -0,0 +1,161 @@
+---
+id: 5de219e6-d9b9-4abf-9367-998109cd57cd
+title: Developing a Pod
+desc: ''
+updated: 1614965542487
+created: 1614201272488
+---
+## Summary
+- status: WORK_IN_PROGRESS 🚧
+In this module, we'll go over how to create a custom pod. You can clone the end result [here](https://github.com/dendronhq/hello-pod)
+## Pre-requisites
+- Install dendron-cli
+  ![[dendron.topic.cli#installation,1:#*]]
+- [[Install Dendron|dendron.guides.install#install]] and have a workspace initialized
+## Tutorial
+### Create your pod
+- NOTE: this tutorial goes over developing using javascript. All Dendron packages are typed and can also be developed using typescript
+```sh
+mkdir hello-pod
+npm init -y
+npm install --save @dendronhq/pods-core
+touch index.js
+```
+Open index.js and add the following
+```js
+const { PublishPod } = require("@dendronhq/pods-core");
+class HelloPod extends PublishPod {
+  static id = "hello";
+  static description = "Add a hello statement";
+  async plant(opts) {
+    const { note } = opts;
+    const body = note.body;
+    return ["Hello World", body].join("\n");
+  }
+}
+module.exports = {
+  pods: [HelloPod],
+};
+```
+## Testing your pod
+1. Create a symlink of your current package. This lets you use your package locally in other projects
+   ```sh
+   npm link
+   ```
+2. Go to your [[workspace root|dendron.ref.layout#workspace-root]].
+   ```sh
+   cd $WORKSPACE_ROOT
+   ```
+3. If you don't have a `package.json` already , create one by running `npm init -y`
+   ```sh
+   npm init -y
+   ```
+4. Link to your created pod
+   ```sh
+   npm link hello-pod
+   ```
+5. Excecute your pod
+   ```sh
+   dendron-cli publishPod --wsRoot . --podId hello --podPkg hello-pod --podSource remote --config fname=dendron,vaultName=vault,dest=stdout
+   ```
+   - since I was running this in a new Dendron vault, I got the following output
+```markdown
+Hello World
+## The Trail 🥾
+Here are the basics of Dendron so you can get started growing your knowledge base.
+- [ ] Create your first note.
+    - [ ] Dendron uses the [lookup](https://www.dendron.so/notes/a7c3a810-28c8-4b47-96a6-8156b1524af3.html#lookup-menu) command to create. So, hit CMD+L (or ctrl+L if you're on Windows) to bring up the lookup bar, type in a new note name and hit enter to create it. You can also run the lookup command through the command palette "Dendron: Lookup".
+    - [ ] Wiki-style links are supported. If the note doesn't exist, we'll create the note for you. For example, just try [[this link]] from the editor view.
+- [ ] Find your notes. Dendron really shines when you need to look up notes quickly. For this, you use *drumroll* the lookup command (again). Just hit CMD/ctrl+L and you can search your entire set of notes.
+- [ ] To delete a note, navigate to it and use the "Dendron: Delete Node" command. As with everything else in VSCode, bring up the command palette with CMD/ctrl+shift+P and run the command.
+- [ ] Use a [snippet](https://www.dendron.so/notes/9eca1992-7540-4d9d-97fb-328b27748b2c.html) for quick note templates
+- [ ] Insert an [image](https://www.dendron.so/notes/a91fd8da-6895-49fe-8164-a17acd8d9a17.html)
+- [ ] Create some [links](https://www.dendron.so/notes/3472226a-ff3c-432d-bf5d-10926f39f6c2.html)
+- [ ] [Publish](https://www.dendron.so/notes/73d395c9-5041-4d0d-9db7-080d9586136e.html) your vault
+- [ ] Join us on [discord](https://discord.com/invite/6j85zNX) and discuss all things knowledge management with your fellow trail blazers.
+- [ ] For more information, see Dendron's basic [concepts](https://www.dendron.so/notes/c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50.html)
+```
+### Pass in custom configuration values
+We're going to make our publishing a little more dynamoc by using custom configuration.
+Modify your pod to accept a new configuration parameter
+```js
+const { PublishPod } = require("@dendronhq/pods-core");
+class HelloPod extends PublishPod {
+  static id = "hello";
+  static description = "Add a hello statement";
+  get config() {
+    return super.config.concat([
+      {
+        key: "name",
+        description: "dev.to api key",
+        type: "string",
+      },
+    ]);
+  }
+  async plant(opts) {
+    const { note, config } = opts;
+    const body = note.body;
+    return [`Hello ${config.name}`, body].join("\n");
+  }
+}
+module.exports = {
+  pods: [HelloPod],
+};
+```
+Below is a diff to make the changes a bit more obvious.
+![diff of code](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pod-change.jpg)
+Run the pod again the the additional argument.
+````
+```sh
+dendron-cli publishPod --wsRoot . --podId hello --podPkg hello-pod --podSource remote --config fname=dendron,vaultName=vault,dest=stdout,name=Albert
+```
+````
+```markdown
+Hello Albert
+## The Trail 🥾
+...
+```
+### Use Note Metadata
+Pods have full access to all the metadata attached to a note. You can see the pod arguments below
+![[dendron.topic.pod.sdk#plantopts-publishpodplantoptst,1]]
+TODO - You can see an example of this [[here|dendron.pro.devto-pod]]
+### Using Typescript
+TODO - You can see an example of this [[here|dendron.pro.devto-pod]]

Added: vault/dendron.topic.pod.md

Files changed (1) hide show

vault/dendron.topic.pod.md +55 -0

vault/dendron.topic.pod.md ADDED Viewed

@@ -0,0 +1,55 @@
+---
+id: 66727a39-d0a7-449b-a10d-f6c438185d7f
+title: Pods
+desc: ''
+updated: 1614190960609
+created: 1602958663144
+---
+<img src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pods.png" height="300px"/>
+> Pod image courtesy of [Ilana Lin](https://www.instagram.com/ilana_lin/)
+Dendron refers to pods as any tool or location that is used to hold information. Tools like Evernote and Roam are pods. Social media services like Twitter and Facebook are pods. Publication destinations like static sites and Medium are pods. Everything is a pod.
+Pods let you do the following:
+- **import** your notes from any existing location into Dendron
+- **export** your notes from Dendron to any existing location
+- **publish** your notes from Dendron to any existing location
+To access pods, Dendron exposes three commands:
+- `Dendron: Import Pod`: imports notes
+- `Dendron: Export Pod`: export notes
+- `Dendron: Publish Pod`: publish notes
+**NOTE**: not all pods will expose all three commands. Each pod implementation can choose to implement any subset of the three commands.
+## Pod Methods
+### Import
+Importing lets you bulk import notes from a given source and into Dendron. The notes are formatted and converted to Dendron's hierarchal structure.
+### Export
+Exporting lets you bulk export notes from Dendron into another destinations. The notes will be formatted and converted to the native format of the destination.
+### Publish
+Publishing lets you take one note and output it into a different format/destination.
+For example, you might want to use our [[markdown pod|dendron.topic.pod.builtin.markdown]] to take a note with [[note references|dendron.topic.refs]] and publish it as a regular markdown note to use in a github issue or another tool.
+Future uses of the **publish** method will be taking a note and publishing it to social media (eg. twitter, facebook, linkedin), publishing it to Gmail, and publishing to destinations like Medium and dev.to.
+## Types of Pods
+There are two types of pods:
+- builtin: created by dendron
+- remote: created by third parties
+![[dendron.topic.pod.builtin#summary,1:]]
+![[dendron.topic.pod.custom#summary,1:]]

Added: vault/dendron.topic.pod.sdk.md

Files changed (1) hide show

vault/dendron.topic.pod.sdk.md +36 -0

vault/dendron.topic.pod.sdk.md ADDED Viewed

@@ -0,0 +1,36 @@
+---
+id: 6301a5b4-d88f-4ecd-ad72-0880b1bf14b0
+title: Sdk Reference
+desc: ''
+updated: 1614215063307
+created: 1614214703771
+---
+## PublishPod
+Base class to be extended when creating a pod for [[publishing|dendron.topic.pod#publish]]
+### plant(opts: PublishPodPlantOpts<T>)
+- opts
+    - engine: DEngineClientV2
+    - config: PublishPodConfig
+    - note: NotePropsV2
+```ts
+export type NotePropsV2 = {
+  id: string;
+  title: string;
+  desc: string;
+  links: DLink[];
+  fname: string;
+  updated: string;
+  created: string;
+  parent: DNodePointerV2 | null;
+  children: DNodePointerV2[];
+  body: string;
+  custom?: any;
+  schema?: { moduleId: string; schemaId: string };
+  vault: DVault;
+  ...
+};
+```

Added: vault/dendron.topic.preview.md

Files changed (1) hide show

vault/dendron.topic.preview.md +23 -0

vault/dendron.topic.preview.md ADDED Viewed

@@ -0,0 +1,23 @@
+---
+id: 8de4209d-84d3-45f8-96a4-34282e34507d
+title: Preview
+desc: ''
+updated: 1603383860949
+created: 1603383580067
+---
+The preview pane renders the Dendron's markdown text into nicely formatted HTML. The preview is a fork of the [markdown-preview-enhanced extension](https://github.com/shd101wyy/vscode-markdown-preview-enhanced).
+All documentation pertaining to the original extension can be found [here](https://shd101wyy.github.io/markdown-preview-enhanced/#/). This page will highlight some key features as well as Dendron specific additions.
+### Table of Contents
+You can toggle a table of contents from the preview pane using a button toggle.
+<a href="https://www.loom.com/share/516b862bc30b49edbff3239632e35f90">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/516b862bc30b49edbff3239632e35f90-with-play.gif"> </a>
+### Issues
+- Preview does not persist between reloads/restarts
+  - Workaround: [Always show preview of md being edited](./dendron.guides.tips.md#always-show-preview-of-md-being-edited)

Added: vault/dendron.topic.publishing-legacy.commands.md

Files changed (1) hide show

vault/dendron.topic.publishing-legacy.commands.md +11 -0

vault/dendron.topic.publishing-legacy.commands.md ADDED Viewed

@@ -0,0 +1,11 @@
+---
+id: 90a86fc3-4ea1-4596-a6d5-247fe0213b1c
+title: Commands
+desc: ''
+updated: 1600575510386
+created: 1600575510386
+stub: false
+nav_order: 3.5
+---
+((ref:[[dendron.topic.commands]]#publishing,1:#Dev))

Added: vault/dendron.topic.publishing-legacy.configuration.md

Files changed (1) hide show

vault/dendron.topic.publishing-legacy.configuration.md +270 -0

vault/dendron.topic.publishing-legacy.configuration.md ADDED Viewed

@@ -0,0 +1,270 @@
+---
+id: ffa6a4ba-5eda-48c7-add5-8e2333ba27b4
+title: Configuration
+desc: ''
+updated: 1613770983668
+created: 1600564020051
+nav_order: 3
+---
+Dendron lets you control publication behavior at three levels:
+- **globally** through `dendron.yml` configuration
+- **per note** through the publication related frontmatter
+- **per line** through custom dendron directives inside the note
+## Global Configuration
+The `dendron.yml` configuration file controls what notes get published. It is located at the root of your workspace.
+```
+.
+└── {workspace}
+    └── dendron.yml
+```
+Below is the config that is used to publish `dendron.so` from the contents of this [repo](https://github.com/dendronhq/dendron-template)
+```yml
+site:
+  siteHierarchies: [dendron]
+  siteRootDir: docs
+```
+### Properties
+#### assetsPrefix?:
+Prefix for assets.
+- NOTE: By default, assets are served from the root. If you are publishing to github pages and followed the instructions [here](https://pages.github.com/) by creating a repo named `{username}.github.io`, then no further action is needed. This is because github will make your site available at `https://{username}.github.io`. If you created a custom repo, you will need to set the prefix to the name of your repo because github will make your site available at `https://username.github.io/{your-repo-name/}`
+#### copyAssets
+- required: no
+- type: boolean
+- default: true
+Copy assets from vault to site.
+#### siteHierarchies: str\[]
+List of hierarchies to publish
+#### siteIndex?: str
+- optional, path of your index (home page)
+- defaults to the first element of `siteHierarchies`
+#### siteRootDir
+Location of the directory where site will be build. Relative to your workspace
+#### siteRepoDir
+- required: no
+- type: string
+Location of the github repo where your site notes are located. By default, this is assumed to be your `workspaceRoot` if not set. This is used with the `Publish Notes` command
+#### usePrettyRefs
+- default: True
+Whether to use pretty note refs or plain refs.
+#### config
+Per hierarchy specific config. To set options for **all** hierarchies, set `{hiearchy name}` to **root**.
+```yml
+config:
+  {hierarchy name}: {hierarchy options}
+```
+The list of possible options:
+- **publishByDefault**: boolean, default: true
+  - if set to false, dendron will only publish notes within the hierarchy that have `published: true` set in the frontmatter
+- **noindexByDefault**: boolean, default: false
+  - if set to true, dendron will add the following meta tag `<meta name="robots" content="noindex, nofollow”>` which will tell google to not index your page
+  - when google indexes a page, it will penalize sites that have duplicate content from other sites. this is useful if you are using your hiearchy as a [[cache|dendron.workflows.cache]]
+- **customFrontmatter**: list, default: \[]
+  - if set, dendron will add the specified frontmatter to each published note in the hierarchy. note that this will override existing keys with the same name when publishing
+  - eg. add `toc: true` to all notes published under the `iam.*` hierarchy
+  ```yml
+    config:
+      iam:
+          customFrontmatter: [
+            {
+              key: "toc",
+              value: true,
+            }
+          ]
+  ```
+### Examples
+#### Blog
+Below is the config for [kevinslin.com](https://kevinslin.com). It publishes everything under the `home` and `blog` hierarchies but will only publish notes under `books` if `published: true` is set on the frontmatter.
+- dendron.yml
+```yml
+site:
+  siteHierarchies: [home, blog, books]
+  siteRootDir: docs
+  config:
+    books:
+      publishByDefault: false
+```
+#### Example publishing entire vault
+- vault
+```
+.
+├── root.md
+├── dendron.md
+├── dendron.quickstart.md
+├── dendron.zen.md
+├── flowers.md
+└── flowers.bud.md
+```
+- dendron.yml
+```yml
+publish:
+  siteHierarchies: [root]
+```
+- what gets published
+```
+.
+└── root.md
+    ├── dendron
+    │   ├── dendron.quickstart
+    │   └── dendron.zen
+    └── flowers
+        └── flowers.bud
+```
+#### Example publishing just one domain
+- vault
+```
+.
+├── root.md
+├── dendron.md
+├── dendron.quickstart.md
+└── dendron.zen.md
+```
+- dendron.yml
+```yml
+publish:
+  siteHierarchies: [dendron]
+```
+- published:
+```
+.
+└── dendron
+    ├── dendron.quickstart
+    └── dendron.zen
+```
+## Vault Configuration
+The following needs to be set in the [[vaults|dendron.topic.config#vaults]] section of the config.
+![[dendron.topic.config#visibility:#*]]
+## Note Configuration
+You can specify how notes are published via the frontmatter of each note.
+### Properties
+#### published
+- type: boolean
+- default: true
+To exclude a page from publication, you can add the following to the frontmatter. If you set `publishByDefault: false` for a hierarchy, this needs to be set to `true` to publish
+```yml
+...
+published: false
+```
+#### noindex
+- type: boolean
+- default: true
+To tell google to not index a page, you can add the following tag to the frontmatter. You can also have this as a default for a given hierarchy by setting `noIndexByDefault: true` in the site config.
+```yml
+...
+noindex: true
+```
+#### toc
+- type: boolean
+- default: false
+To generate a table of contents in a given note, enable this directive in the note frontmatter.
+```yml
+toc: true
+```
+You will also need to include the following line somewhere in the note body. Dendron will generate a table of contents when it finds that particular header
+```md
+## Table of Contents
+```
+The output will look like the below.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/change.toc.jpg)
+- NOTE: in order to generate a table of contents, the heading levels after ToC need to be at an equal level or greater than the heading level of `Table of Contents`
+  - this is okay
+  ```markdown
+  ## Table of Contents
+  ## Header1
+  ## Header2
+  ```
+  - this is not
+  ```markdown
+  ## Table of Contents
+  ### Header1
+  ### Header2
+  ```
+## Line Configuration
+You can control publication on a per line basis.
+## Properties
+### LOCAL_ONLY_LINE
+Sometimes, you just want to keep a few lines private while publishing the rest of your vault. You can do that with `Local only`. In order to mark a line as `Local Only`, add the following markdown comment at the end of the line: `<!--LOCAL_ONLY_LINE-->`
+```markdown
+Hello World!  <!-- Will be published -->
+This is a secret <!--LOCAL_ONLY_LINE--> <!-- won't be published -->
+```
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pod-local.gif)

Added: vault/dendron.topic.publishing-legacy.local-preview.md

Files changed (1) hide show

vault/dendron.topic.publishing-legacy.local-preview.md +66 -0

vault/dendron.topic.publishing-legacy.local-preview.md ADDED Viewed

@@ -0,0 +1,66 @@
+---
+id: 63b184f7-1901-4580-af40-97ef87069a04
+title: Local Preview
+desc: ''
+updated: 1600740884846
+created: 1600740884846
+stub: false
+nav_order: 2.1
+---
+> The following guide was created by fellow Dendronite [Ed](https://github.com/ens100)!
+In order to publish your notes, we have included a brief step by step guide to get you started.
+In a nutshell, we need to:
+- Install Ruby
+- Install Jekyll
+- Set up the environment
+- Publish our notes
+- Enjoy the fruits of our labor
+Although these may seem complex, I hope the following guide will assist and make things as simple as possible.
+## Installing Ruby
+Ruby version 2.5.0 or higher is needed, so open a Terminal window (eg. PowerShell / cmd) and type `ruby -v`. If the error message "_ruby : The term 'ruby' is not recognized_" comes up do the following:
+- Navigate [here](https://rubyinstaller.org/downloads/) and download the recommended **Ruby+Devkit** and then open the downloaded file.
+- When the installation is complete you will see an option to Run `ridk install`. Make sure this is checked as it is needed for installing Jekyll and click finish.
+- A terminal window will open asking what components to install - Simply press the `enter` key to install the default components.
+- Close the terminal and reopen a new iteration to ensure that the Path variables have been set.
+- In the newly opened Terminal run `ruby -v` and you should get `ruby 2.6.6p146 (2020-03-31 revision 67876) [x64-mingw32]` or similar back.
+## Installing Jekyll
+- From the Terminal type `gem install jekyll bundler` and let it run until finished (takes a few minutes).
+- When completed run `jekyll -v` and the Terminal should return with something like: `jekyll 4.1.1`.
+Step 1 and 2 over and done with.
+## Setting up the Environment
+- In the Terminal navigate to the `docs` folder within your dendron vault.
+  - The easiest way to do this is to copy the location of the folder in File Explorer and then go to the Terminal and type `cd ` and paste the copied text and then click enter.
+- Run `bundle install`
+We are approaching the finishing line.
+## Publishing Our Notes
+In order for our notes / markdown files to be published we need to carry out the following steps:
+- From within Dendron, run the "Build Pod" command by clicking `ctrl + Shift + P` and typing Pod. This will bring up the option `> Dendron: Build Pod`, select it and click enter.
+- In the bottom right hand side after a few seconds you should see "finished".
+## Last Step
+- Open the terminal and type `bundle exec jekyll serve`
+- This will run a configuration to generate the markdown files to static pages so that they can be viewed online.
+- Once the above step is completed, open a web browser and navigate to `http://localhost:4000/`.
+- You should see a copy of your notes using a similar theme as this one.
+You will be able to see any changes you do to your notes in Dendron on the localhost.
+Think this deserves a high five!

Added: vault/dendron.topic.publishing-legacy.md

Files changed (1) hide show

vault/dendron.topic.publishing-legacy.md +15 -0

vault/dendron.topic.publishing-legacy.md ADDED Viewed

@@ -0,0 +1,15 @@
+---
+id: 73d395c9-5041-4d0d-9db7-080d9586136e
+title: Publishing Legacy
+desc: ''
+updated: 1613875845679
+created: 1595170096361
+stub: true
+nav_exclude: true
+---
+Dendron lets you publish the contents of your vault, either in its entirety or only a subset. Notes are published under the [dendron-jekyll theme](https://github.com/dendronhq/dendron-jekyll).
+You can find documentation about the theme [[here|dendron.pro.dendron-jekyll]]
+- NOTE: Jekyll based publishing is now DEPRECATED. We encourage everyone to move to [[Publishing V2|dendron.topic.publishing]]

Added: vault/dendron.topic.publishing-legacy.quickstart.md

Files changed (1) hide show

vault/dendron.topic.publishing-legacy.quickstart.md +35 -0

vault/dendron.topic.publishing-legacy.quickstart.md ADDED Viewed

@@ -0,0 +1,35 @@
+---
+id: c800d576-789c-4a68-ac03-a66efd40d39b
+title: Quickstart
+desc: ''
+updated: 1600564090683
+created: 1600564090683
+stub: false
+nav_order: 2
+---
+NOTE: it's possible to publish Dendron on any platform that can host static sites. This guide covers publishing to [Github Pages](https://pages.github.com/)
+### Pre-requisites
+- Create an account on [github](https://github.com/)
+- Follow the instructions [here](https://pages.github.com/) to create a repository named `{username}.github.io` where `{username}` is your username on Github
+- Setup a github repo with [github pages enabled](https://guides.github.com/features/pages/)
+  - when selecting the source, make sure to pick `master branch/docs folder`
+    ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/gh-page-docs.jpg)
+- Create an initial commit and push your vault to your github page
+### Guide
+1. Depending on what notes you want to publish, you will want to update your `dendron.yml` file. By default, everything will be published
+2. Update the contents of `_config.yml` inside your `docs` folder to specify site wide configuration like logo and title.
+   - NOTE: this is located relative to `dendron.rootDir`
+   - if you do not have a `docs` folder, you can run `Dev:Dendron: Doctor` to create one
+3. When you are ready to publish, run the `> Dendron: Build Pod` command to prepare your site for publication. This builds your notes into the `siteRootDir` directory which defaults to `docs`. `Build Pod` does the following when it builds your site:
+   - copies over the notes specified in `dendron.yml`
+   - creates a copy of your notes with the ids in place of the file names
+   - updates all `wiki-links` to `markdown-links` so Jekyll can process it, preserving titles if there are any
+4. Commit your changes.
+5. Push your repository using `> Git: Push`
+<a href="https://www.youtube.com/watch?v=VOZJxKg0-js">![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dendron-publishing.jpg)</a>

Added: vault/dendron.topic.publishing.advanced.md

Files changed (1) hide show

vault/dendron.topic.publishing.advanced.md +57 -0

vault/dendron.topic.publishing.advanced.md ADDED Viewed

@@ -0,0 +1,57 @@
+---
+id: e9f26a4b-ddce-41b3-9619-8f4f64761f86
+title: Advanced
+desc: ''
+updated: 1614535629477
+created: 1600564193281
+---
+### Exclude from publication
+To exclude a page from publication, you can add the following to the frontmatter. If you set `publishByDefault: false` for a hierarchy, this needs to be set to `true` to publish
+```yml
+...
+published: false
+```
+### Exclude from indexing
+To tell google to not index a page, you can add the following tag to the frontmatter. You can also have this as a default for a given hierarchy by setting `noIndexByDefault: true` in the site config.
+```yml
+...
+noindex: true
+```
+<!-- ### Exclude line from publication
+Sometimes, you just want to keep a few lines private while publishing the rest of your vault. You can do that with `Local only`. In order to mark a line as `Local Only`, add the following markdown comment at the end of the line: `<!--LOCAL_ONLY_LINE-->`
+```markdown
+Hello World!  <!-- Will be published -->
+This is a secret <!--LOCAL_ONLY_LINE--> <!-- won't be published -->
+``` -->
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pod-local.gif)
+<!-- ### Link Checking
+It's useful to check if all your links work before publishing your notes. You can use the [awesome-bot](https://github.com/dkhamsing/awesome_bot) gem to validate your links.
+- setup
+  - create a folder named `reports` to hold the results
+    ```
+    cd {wsRoot}
+    mkdir reports
+    ```
+  - add `reports` to your vscode workspace in order to browse it via vscode
+- check links
+  - build your site using the `Build Pod` command
+  - start a local server
+  - run the following command
+    ```bash
+    cd {wsRoot}/reports && awesome_bot ../docs/_site/notes/*.html --allow-redirect --allow-dupe --allow 429
+    ```
+ -->

Added: vault/dendron.topic.publishing.blogging.md

Files changed (1) hide show

vault/dendron.topic.publishing.blogging.md +51 -0

vault/dendron.topic.publishing.blogging.md ADDED Viewed

@@ -0,0 +1,51 @@
+---
+id: 6d21fd60-e564-4a55-b4c0-d2586293b908
+title: Blogging
+desc: ''
+updated: 1614547898424
+created: 1614547017272
+---
+You can use Dendron for blogging. To do so, add [[collection specific options |dendron.topic.publishing.configuration#collection-options]] to your frontmatter.
+### Using Collections
+The following frontmatter results in the page [here](https://www.kevinslin.com/notes/b9bc4aa1-4369-446d-91a9-13d4f2a4b8e5.html).
+```yml
+has_collection: true
+sort_by: date
+sort_order: reverse
+```
+The original hierarchy :
+```sh
+blog.thoughts.md
+blog.thoughts.2021-02-03-foo.md
+blog.thoughts.2021-02-03-bar.md
+...
+```
+### Using Journal Notes
+You can also designate a journal hierarchy as a collection. The following frontmatter is responsible for the page [here](https://www.kevinslin.com/notes/eda0b03c-270c-4c49-9080-46bd8eb55a1e.html)
+```yml
+has_collection: true
+sort_by: date
+sort_order: reverse
+skipLevels: 2
+```
+The original hierarchy :
+```sh
+dendron.md
+dendron.journal.md
+dendron.journal.2021.02.01.md
+dendron.journal.2021.02.02.md
+dendron.journal.2021.02.03.md
+...
+```

Added: vault/dendron.topic.publishing.changelogs.md

Files changed (1) hide show

vault/dendron.topic.publishing.changelogs.md +29 -0

vault/dendron.topic.publishing.changelogs.md ADDED Viewed

@@ -0,0 +1,29 @@
+---
+id: e1b84d7e-9b0d-4616-917f-f3af1e7541b0
+title: Changelogs
+desc: ''
+updated: 1615241456334
+created: 1615241095799
+---
+## Summary
+- status: 🚧
+Dendron can now generate a changelog for your published site. Note that this feature is currently experimental and will only generate the changelog for your latest commit. It also requires that you be using `git` to store your notes. When enabled, this will add `Changelog` to your nav bar which will have your most recent commit.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Fullscreen_3_8_21__2_05_PM.jpg)
+## Enable Changelogs
+Update `dendron.yml`
+![[dendron.topic.config#generatechangelog:#*]]
+## Limitations
+The current version of changelogs is deliberately limited as we are iterating on the feature. Currently it will only generate a diff based off the latest local git commit. It also assumes that your entire workspace is versioned using one git repo.
+## FAQ
+### How is this different from a `git diff`?
+The changelog view will only show the diff of any public notes

Added: vault/dendron.topic.publishing.collections.md

Files changed (1) hide show

vault/dendron.topic.publishing.collections.md +25 -0

vault/dendron.topic.publishing.collections.md ADDED Viewed

@@ -0,0 +1,25 @@
+---
+id: e4ea4fe3-0350-492e-863a-687d9fc15993
+title: Collections
+desc: ''
+updated: 1614538231995
+created: 1609433737726
+---
+Sometimes, you might want to publish a page that has all its children listed like in a blog archive format.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.collection.jpg)
+This format is called a `collection` in Dendron. You can designate that a page be published as a collection by setting the [[has_collection|dendron.topic.publishing.configuration#has_collection]] property in the note frontmatter.
+You can see an example of it [here](https://www.kevinslin.com/notes/e9c72b4f-adb8-4f15-a6aa-9f9d81538561.html).
+## Sorting
+Sorting is by the `created` attribute by default. If you wish to set an override, you can add a `date` attribute in `YYYY-MM-DD` format (eg. `date: '2019-08-08'`)
+You can control sort order via the [[sort_order|dendron.topic.publishing.configuration#sort_order]] attribute.
+## Skip Levels
+![[dendron.topic.publishing.configuration#skiplevels,1:#*]]

Added: vault/dendron.topic.publishing.configuration.md

Files changed (1) hide show

vault/dendron.topic.publishing.configuration.md +453 -0

vault/dendron.topic.publishing.configuration.md ADDED Viewed

@@ -0,0 +1,453 @@
+---
+id: f2ed8639-a604-4a9d-b76c-41e205fb8713
+title: Configuration
+desc: ''
+updated: 1614655770757
+created: 1608528797892
+nav_order: 3
+---
+## Summary
+Dendron lets you control publication behavior at multiple levels:
+- **globally** using `dendronConfig.site`
+- **per hiearchy** through `dendronConfig.site.config`
+- **per note** through the publication related frontmatter
+- **per line** through custom dendron directives inside the note
+## Global Configuration
+The `dendron.yml` configuration file controls what notes get published. It is located at the root of your workspace.
+```
+.
+└── {workspace}
+    └── dendron.yml
+```
+Below is the config that is used to publish `dendron.so` from the contents of this [repo](https://github.com/dendronhq/dendron-template)
+```yml
+site:
+  siteHierarchies: [dendron]
+  siteRootDir: docs
+```
+### assetsPrefix (optional)
+- default: none
+Prefix for assets.
+- NOTE: By default, assets are served from the root. If you are publishing to github pages and followed the instructions [here](https://pages.github.com/) by creating a repo named `{username}.github.io`, then no further action is needed. This is because github will make your site available at `https://{username}.github.io`. If you created a custom repo, you will need to set the prefix to the name of your repo because github will make your site available at `https://username.github.io/{your-repo-name/}`
+### copyAssets (optional)
+- default: true
+Copy assets from vault to site.
+### customHeaderPath (optional)
+If set, set path to a custom header file (relative to your workspace root) which will be included in all your published pages
+```yml
+site:
+  ...
+  customHeaderPath: header.html
+```
+- header.html
+```
+<script> console.log("hello world"); </script>
+```
+### duplicateNoteBehavior (optional)
+When publishing in multi-vault scenario, how to handle duplicate notes
+Currently, only the `useVault` option is allowed. It takes a list of [[vault names|dendron.topic.config#name]]. When a duplicate is found, Dendron will go throw the vaults in your list from left to right and resolve to the first one that matches.
+- NOTE: this is done automatically when you run the [[Vault Add|dendron.topic.commands#vault-add]] command
+```yml
+duplicateNoteBehavior:
+  action: "useVault"
+  payload: [{vault1}, {vault2}, {vault3}]
+```
+### ga_tracking (optional)
+Your ga tracking number if you want to add google analytics.
+- NOTE: won't be included in `dev` preview
+### githubCname (optional)
+- default: none
+Cname used for github pages
+### logo (optional)
+- default: none
+- eg: `vault/assets/images/logo.png`
+Used to add a logo image for all headers
+### siteFaviconPath (optional)
+- default: "favicon.ico"
+Path to favicon. Relative to workspace.
+### siteHierarchies (required)
+- default: [root]
+List of hierarchies to publish. `root` is a special value that means `publish all`.
+### siteLastModified (optional)
+- default: false
+If set to true, show a last modified at the bottom of your site. This value is set form the `updated` timestamp in your note frontmatter.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.last-modified.jpg)
+### siteIndex (optional)
+- default: first element of `siteHiearchies`
+Path of your index (home page)
+### siteProtocol (optional)
+- default: https
+Website protocol
+### siteRootDir (required)
+- default: "docs"
+Location of the directory where site will be build. Relative to your workspace
+### siteRepoDir (optional)
+- default: none
+- status: NOT currently supported
+Location of the github repo where your site notes are located. By default, this is assumed to be your `workspaceRoot` if not set. This is used with the `Publish Notes` command
+### siteUrl
+- required
+Set to the URL that you plan on publishing to. All links will be prefixed with this.
+If you are publishing with github pages, the format is `https://{username}.github.io/{repo}/`
+### usePrettyRefs (optional)
+- default: True
+Whether to use pretty note refs or plain refs.
+### writeStubs (optional)
+- default: true
+Whether to write [[stubs|dendron.concepts#stubs]] when publishing.
+Writing a stub will create an empty note in your vault with the name of the stub.
+Writing stubs is important to guarantee permanent urls as Dendron will randomize stub ids whenever Dendron restarts.
+### Github Options
+#### gh_edit_link
+- default: true
+  Show a edit on github link at the bottom of the page
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publish.edit-on-github.jpg)
+#### gh_edit_repository
+the URL of the project's GitHub repository
+- NOTE: if you are using [[remote vaults|dendron.concepts#remote-vault]], this value will be ignored and the [[remote url|dendron.topic.config#remote]] will be used instead
+#### gh_edit_branch
+- default: master
+the branch that the docs site is served from
+#### gh_edit_view_mode
+- default: tree (brings user to github page)
+switch to "edit" to bring the user directly into editing mode
+### SEO Options
+#### title
+- title of page
+- eg: `Dendron`
+#### description
+- eg: `Dendron is a local-first, markdown based, hierarchical note taking tool. It is meant to help you create, organize, and collaborate on knowledge bases of any size.`
+#### author
+Name of person or organization doing the publishing
+- eg: `Kevin`
+#### twitter
+Twitter Handle
+- eg: `dendronhq`
+## Hierarchy Configuration
+You can update configuration on a per hierarchy level by modifying `site.config` like in the example below
+```yml
+site:
+  config:
+    dendron:
+      publishByDefault: true
+      ...
+```
+To set options for **all** hierarchies, set `{hiearchy name}` to **root**.
+### publishByDefault
+- default: true
+- values: true|false|hashByVault
+If set to false, dendron will only publish notes within the hierarchy that have `published: true` set in the frontmatter
+If set as a hash, you can further specify `publishByDefault` settings on a per vault basis. The key is the name of the vault and the value is a boolean.
+For example, the following config says that the `finance` hiearchy in the `public` vault should all be published but that the `finance` hiearchy in the `private` vault should not
+```yml
+site:
+  config:
+    finance:
+      publishByDefault:
+        public: true
+        private: false
+```
+### noindexByDefault
+- default: false
+- status: NOT currently supported
+If set to true, dendron will add the following meta tag `<meta name="robots" content="noindex, nofollow”>` which will tell google to not index your page
+When google indexes a page, it will penalize sites that have duplicate content from other sites. this is useful if you are using your hiearchy as a [[cache|dendron.workflows.cache]]
+### customFrontmatter
+- default: \[]
+If set, dendron will add the specified frontmatter to each published note in the hierarchy. note that this will override existing keys with the same name when publishing
+- eg. add `toc: true` to all notes published under the `iam.*` hierarchy
+```yml
+  config:
+    iam:
+        customFrontmatter: [
+          {
+            key: "toc",
+            value: true,
+          }
+        ]
+```
+## Examples
+### Example publishing entire vault
+- vault
+```
+.
+├── root.md
+├── dendron.md
+├── dendron.quickstart.md
+├── dendron.zen.md
+├── flowers.md
+└── flowers.bud.md
+```
+- dendron.yml
+```yml
+publish:
+  siteHierarchies: [root]
+```
+- what gets published
+```
+.
+└── root.md
+    ├── dendron
+    │   ├── dendron.quickstart
+    │   └── dendron.zen
+    └── flowers
+        └── flowers.bud
+```
+### Example publishing just one domain
+- vault
+```
+.
+├── root.md
+├── dendron.md
+├── dendron.quickstart.md
+└── dendron.zen.md
+```
+- dendron.yml
+```yml
+publish:
+  siteHierarchies: [dendron]
+```
+- published:
+```
+.
+└── dendron
+    ├── dendron.quickstart
+    └── dendron.zen
+```
+### Examples of CNAME, Github and SEO Options
+```yml
+site:
+    siteHierarchies:
+        - dendron
+    siteRootDir: docs
+    gh_edit_repository: "https://github.com/dendronhq/dendron-site"
+    logo: "vault/assets/images/logo.png"
+    siteUrl: "https://dendron.so"
+    githubCname: "dendron.so"
+    title: Dendron
+    author: "dendronhq"
+    twitter: "dendronhq"
+    description: "Dendron is a local-first, markdown based, hierarchical note taking tool. It is meant to help you create, organize, and collaborate on knowledge bases of any size."
+vaults:
+    - fsPath: vault
+```
+## Note Configuration
+You can specify how notes are published via the frontmatter of each note.
+### published
+- default: true
+To exclude a page from publication, you can add the following to the frontmatter. If you set `publishByDefault: false` for a hierarchy, this needs to be set to `true` to publish
+```yml
+...
+published: false
+```
+### nav_exclude
+If set, do not include the current note in the navigation bar.
+### nav_order
+- type: number
+If set, denote order that item appears in the published nav bar
+### noindex
+- default: false
+To tell google to not index a page, you can add the following tag to the frontmatter. You can also have this as a default for a given hierarchy by setting `noIndexByDefault: true` in the site config.
+```yml
+...
+noindex: true
+```
+### collection options
+#### has_collection
+- default: false
+Whether a given page is a collection. A collection doesn't have a table of contents and allows you to set collection specific options.
+#### date
+If set, used to designate a custom publication date. By default, use timestamp of `created` field.
+#### skipLevels
+If set, determines how many levels of children to skip when making the collection. For example, you might have the following hierarchy.
+```
+- blog.md
+- blog.reading.md
+- blog.reading.journal.md
+- blog.reading.journal.2020.md
+- blog.reading.journal.2020.12.md
+- blog.reading.journal.2020.12.20.one.md
+- blog.reading.journal.2020.12.31.two.md
+```
+When you publish, you might only want to show the leaf nodes and skip the intermediary levels. In the above example, setting `skipLevels: 3` on `blog.reading.md` will result in the following hierarchy being published.
+```
+- blog.md
+- blog.reading.md
+- blog.reading.journal.2020.12.20.one.md
+- blog.reading.journal.2020.12.31.two.md
+```
+#### sort_order
+- default: `ascending`
+- values: `ascending|reverse`
+Sort items in a collection page. Ascending by default. Specify `reverse` to sort in descending order.
+## Line Configuration
+You can control publication on a per line basis.
+### LOCAL_ONLY_LINE
+Sometimes, you just want to keep a few lines private while publishing the rest of your vault. You can do that with `Local only`. In order to mark a line as `Local Only`, add the following markdown comment at the end of the line: `<!--LOCAL_ONLY_LINE-->`
+```markdown
+Hello World!  <!-- Will be published -->
+This is a secret <!--LOCAL_ONLY_LINE--> <!-- won't be published -->
+```
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/pod-local.gif)

Added: vault/dendron.topic.publishing.faq.md

Files changed (1) hide show

vault/dendron.topic.publishing.faq.md +11 -0

vault/dendron.topic.publishing.faq.md ADDED Viewed

@@ -0,0 +1,11 @@
+---
+id: 5a529992-0c62-4291-81df-550638f06a46
+title: FAQ
+desc: ''
+updated: 1609951339287
+created: 1609883599513
+---
+### Why am I taken to a 403 page?
+Dendron will auto-generate 403 pages during publication when a published note links to notes that are not published. You can see [[here|dendron.topic.publishing.selective-publication]] for configuration behind selective publication.

Added: vault/dendron.topic.publishing.features.md

Files changed (1) hide show

vault/dendron.topic.publishing.features.md +80 -0

vault/dendron.topic.publishing.features.md ADDED Viewed

@@ -0,0 +1,80 @@
+---
+id: 2fe96d3a-dcf9-409b-8a09-fdaa5a664433
+title: Features
+desc: ''
+updated: 1614637638117
+created: 1608528227846
+nav_order: 1
+---
+### Nested Hierarchies
+Publishing supports the same nested hierarchies as your notes and allows you to navigate via the sidebar.
+<img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-hierarchy.gif" />
+### Nav Based Hierarchy Hints
+You can see at a glance which notes have children and explore them from the nav without refreshing the page.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dendron.jekyll.gif)
+### Edit on Github
+Every page can accept one-click contributions as long as the contributor has a github account.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/jekyll.edit.jpg)
+Example of making a contribution to Dendron.
+<a href="https://www.loom.com/share/4a1b67f3fd1a40dab16949e9ea5e53dc"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/4a1b67f3fd1a40dab16949e9ea5e53dc-with-play.gif"> </a>
+### Lookup
+If you'd rather not click, dendron-jekyll also supports path based lookup.
+<img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-lookup.gif" />
+### Permanent Ids
+Every page is published using its unique ID which means that urls will never change, even if the filenames do.
+<img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-ids.jpg" />
+If you have a free github account, then you can host your Dendron notes for free using [github pages](https://pages.github.com/)
+<img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-domain.jpg" />
+### Jekyll Liquid Tags and Variables
+You can find the docs on this under [[liquid|dendron.topic.liquid]]
+- NOTE: this will only be "compiled" in the published site but won't be rendered in the regular markdown
+<img style="max-width: 720px;" src="https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/site-liquid.gif" />
+### Selective Publication
+You can choose to publish your whole vault, a single domain, or multiple domains within your vault.
+### Note References
+Dendron has [[note references|dendron.topic.refs]] that let you inline either the whole note or parts of a note into another note. Publishing via Dendron will also publish note references as part of the process.
+<a href="https://www.loom.com/share/8eb01f6c3196415c8aadc4992805a176"> <img style="" src="https://cdn.loom.com/sessions/thumbnails/8eb01f6c3196415c8aadc4992805a176-with-play.gif"> </a>
+### Backlinks
+This is the equivalent to the [[backlinks panel|dendron.topic.workbench#backlinks]] when using the desktop app.
+Backlinks are automatically deduped and also work in a multi-vault setting.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Fullscreen_2_25_21__8_08_PM.jpg)
+<!-- ### Bad Links Report
+When building your site by running `Dendron: Build Pod`, Dendron will generate a bad links report of all wiki-links that did not resolve. It will also update the links to point to a 404 page instead.
+<a href="https://www.loom.com/share/91c4d7b023754b76b4d02519946603e0">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/91c4d7b023754b76b4d02519946603e0-with-play.gif"> </a>
+ -->

Added: vault/dendron.topic.publishing.github.md

Files changed (1) hide show

vault/dendron.topic.publishing.github.md +118 -0

vault/dendron.topic.publishing.github.md ADDED Viewed

@@ -0,0 +1,118 @@
+---
+id: 877f4347-f013-43ba-aec4-87412b2e1bec
+title: Github
+desc: ''
+updated: 1610687706858
+created: 1608770937168
+---
+This guide describes publishing to github using github actions
+## Pre-requisite
+- we assume that you already have your workspace under version control and a repository on github
+## Setup
+1. Checkout the pages branch and push it to github
+```bash
+git checkout -b pages
+git push origin pages
+```
+2. Switch back to your original branch
+- NOTE: if you are using old versions of github, this command will be `git checkout master`
+```bash
+git checkout main
+```
+3. Create a `package.json` at the root of your workspace
+- NOTE: by default, we adopt the [Creative Commons License](https://creativecommons.org/licenses/by/4.0/legalcode) but you might want to change this depending on your use case
+```json
+{
+  "scripts": {
+    "dendron-cli": "dendron-cli"
+  },
+  "license": "CC BY 4.0",
+  "devDependencies": {
+    "@dendronhq/dendron-11ty": "^1.24.4",
+    "@dendronhq/dendron-cli": "^0.24.0"
+  }
+}
+```
+4. Create the workflow `.github/workflows/dendron-action.yml`:
+```yml
+name: Dendron
+on:
+  push:
+    branches:
+    - master
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v2
+    - name: Install npm dependencies
+      run: npm install
+    - name: Build pod
+      run: npm run dendron-cli -- buildSiteV2 --wsRoot .  --stage prod
+    - name: Deploy site
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_branch: pages
+        publish_dir: docs/
+        force_orphan: true
+        cname: "dendron.so"
+```
+5. Commit these changes and then push your main branch
+```bash
+git add .
+git commit -m "add publishing via gh-action"
+git push
+```
+6. Update your github pages setting to build github pages from the `pages` branch and using the root folder.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.pages.jpg)
+7. Github actions will update your page every time you push. You might have to add a change and push before your changes will show up. You can verify that your action is running by clicking on the actions tab in github.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.actions.jpg)
+<!--
+1. Run > Dendron: Doctor
+2. Select `Add Publishing Requirements`
+This will initialize the following files into your dendron workspace
+```
+# package.json
+# .github
+## workflows
+### dendron-action.yml
+```
+3. By default, when you are ready for publishing, Dendron will
+-->
+## Citations
+- this guide is heavily inspired by [[the github action guide|dendron.guides.tips#publish-to-github-pages-with-actions]] originally published by [Luke Carrier](https://github.com/LukeCarrier)

Added: vault/dendron.topic.publishing.guides.md

Files changed (1) hide show

vault/dendron.topic.publishing.guides.md +23 -0

vault/dendron.topic.publishing.guides.md ADDED Viewed

@@ -0,0 +1,23 @@
+---
+id: 1d9c4d11-1536-449b-af6b-a4a1acb203e4
+title: Guides
+desc: ''
+updated: 1611351277601
+created: 1611351130281
+---
+## Vercel
+To publish with vercel, you can use [this repo](https://github.com/dendronhq/workspace-vercel-sample) as a template. Output of this template is [here](https://workspace-vercel-sample.vercel.app/)
+1. Fork the above repository
+2. Deploy in vercel with the following values
+    - build override
+    ```bash
+    npm run dendron-cli -- buildSiteV2 --wsRoot .  --stage prod
+    ```
+    - output override: `docs`
+3. After deployment, update the `dendron.yml` `siteUrl` field to the url of your domain

Added: vault/dendron.topic.publishing.md

Files changed (1) hide show

vault/dendron.topic.publishing.md +8 -0

vault/dendron.topic.publishing.md ADDED Viewed

@@ -0,0 +1,8 @@
+---
+id: 579e379b-3eca-4676-b51c-c66eb26a11b8
+title: Publishing
+desc: ''
+updated: 1614547010717
+created: 1613935381533
+---

Added: vault/dendron.topic.publishing.migration.md

Files changed (1) hide show

vault/dendron.topic.publishing.migration.md +69 -0

vault/dendron.topic.publishing.migration.md ADDED Viewed

@@ -0,0 +1,69 @@
+---
+id: fd26b3ef-7978-41c9-8f45-4c4f8414951d
+title: Migration
+desc: ''
+updated: 1609529113068
+created: 1608528487798
+---
+All values that used to be written into `_config.yml` will now be moved into `dendron.yml`. You can see the currently supported configuration values here: `https://github.com/dendronhq/dendron/blob/master/packages/common-all/src/types.ts#L71:L71`
+If you currently have a Jekyll based Dendron page, note that the following settings have changed:
+- the `url` property from `_config.yml` is now `siteUrl` in `dendron.yml`
+- favicon is now controlled by `siteFaviconPath` in `dendron.yml` and is a path relative to your workspace root
+- `CNAME` is now controlled by `githubCname` property in `dendron.yml`
+- we are using [prismjs](https://prismjs.com/) to do syntax highlighting which means code block highlighting languages might appear under a different identifier. 11ty will throw an error if compiling a language without the right identifier
+  - you can see the list of all supported languages [here](https://prismjs.com/#supported-languages)
+- dendron [[writeStubs|dendron.topic.publishing.configuration#writestubs-optional]] will be set to true by default
+### Sample dendron.yml config
+- publishing without a cname
+```yml
+version: 1
+vaults:
+    - fsPath: vault
+site:
+    copyAssets: true
+    siteHierarchies:
+        - dendron
+    siteRootDir: docs
+    siteUrl: "kevinslin.github.io/dendron-11ty-test"
+    usePrettyRefs: true
+```
+- using custom cname
+```yml
+version: 1
+vaults:
+    - fsPath: vault
+site:
+    copyAssets: true
+    siteHierarchies:
+        - dendron
+    siteRootDir: docs
+    usePrettyRefs: true
+    siteUrl: "https://11ty.dendron.so"
+    githubCname: "11ty.dendron.so"
+```
+### Sample repo
+- [github repo](https://github.com/kevinslin/dendron-11ty-test/deployments/activity_log?environment=github-pages)
+- [github page](https://kevinslin.github.io/dendron-11ty-test/)
+## Gaps
+11ty publishing is currently not at full feature parity with Jekyll publishing. Notably, the following features are missing:
+- ~~`edit on github` links~~
+- ~~`jekyll-seo` functionality~~
+- ~~math~~
+- ~~anchor headers~~
+- setting a custom color theme
+- support for bad links report
+- support for automatically generated toc
+- integration with dendron plugin

Added: vault/dendron.topic.publishing.misc.md

Files changed (1) hide show

vault/dendron.topic.publishing.misc.md +19 -0

vault/dendron.topic.publishing.misc.md ADDED Viewed

@@ -0,0 +1,19 @@
+---
+id: 491cafdd-d4bf-4c6a-9f95-532af4666828
+title: Misc
+desc: ''
+updated: 1614630219483
+created: 1614630136994
+---
+## Markdown Differences
+There are a few differences between a published Dendron site and what you see using the preview. This document attempts to enumerate these difference.
+### Blockquote
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Markdown_-_Dendron.jpg)
+## Related
+- [[Preview Your Site|dendron.topic.publishing.quickstart.preview-your-site]]

Added: vault/dendron.topic.publishing.navigation.md

Files changed (1) hide show

vault/dendron.topic.publishing.navigation.md +30 -0

vault/dendron.topic.publishing.navigation.md ADDED Viewed

@@ -0,0 +1,30 @@
+---
+id: 5f23182f-2936-4790-8d04-00bd502df723
+title: Navigation
+desc: ''
+updated: 1609883540998
+created: 1609563320271
+---
+Dendron has two navigation sections: the nav bar on the left and the table of contents on the bottom of each note.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.nav.jpg)
+## Sort Order
+## Navigation Side Bar
+Nav order is controlled, in order of precedence, by the following:
+- custom [[nav_order|dendron.topic.publishing.configuration#nav_order]] property in the frontmatter
+- alphabetically by title
+The navbar will first show all notes with the `nav_order` property before showing notes alphabetically. Notes with the [[nav_exclude|dendron.topic.publishing.configuration#nav_exclude]] attribute will not be shown in the navbar
+## Table of Contents
+The nav order for the table of contents that is generated at the bottom of each node works in the same way as the navigation side bar.
+## Nav Exclude
+To exclude an item from navigation, you can set the [[nav_exclude|dendron.topic.publishing.configuration#nav_exclude]] on the note frontmatter. This will exclude it from both the navigation side bar and the table of contents.

Added: vault/dendron.topic.publishing.quickstart.md

Files changed (1) hide show

vault/dendron.topic.publishing.quickstart.md +16 -0

vault/dendron.topic.publishing.quickstart.md ADDED Viewed

@@ -0,0 +1,16 @@
+---
+id: 861e4e48-dcc5-4813-a695-8940ba6e64d3
+title: Quickstart
+desc: ''
+updated: 1614538864287
+created: 1608528402469
+nav_order: 2
+---
+# Quickstart
+NOTE: it's possible to publish Dendron on any platform that can host static sites. This guide covers publishing to [Github Pages](https://pages.github.com/)
+This is divided into two parts
+1. Setting up your local workspace for publication
+2. Publishing

Added: vault/dendron.topic.publishing.quickstart.preview-your-site.md

Files changed (1) hide show

vault/dendron.topic.publishing.quickstart.preview-your-site.md +131 -0

vault/dendron.topic.publishing.quickstart.preview-your-site.md ADDED Viewed

@@ -0,0 +1,131 @@
+---
+id: 1399b5d2-28fb-4077-aa5f-c8edbe52bc5d
+title: Preview Your Site
+desc: ''
+updated: 1614965542494
+created: 1610844309611
+nav_order: 1
+---
+## VSCode
+The following describes how to prepare your notes for publication using VSCode.
+### Pre-requisites
+- node version 0.12 or higher, see installation guide [[here|dendron.guides.install-node]]
+### Preview your notes
+1. Navigate to a Dendron workspace. If you don't have one, you can create one by running `> Dendron: Initialize Workspace` and choosing `empty repository`
+2. Run `Site: Preview` to launch the site preview
+   - The first time you run this, you will need to install the required dependencies. Hit install to do so
+     ![Install dependencies](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.site-preview.jpg)
+   - when dependencies are done installing, Dendron will automatically open up a browser with a preview of your published notes (if this is the first time you've run this, VSCode will ask you for permission to open the link)
+     ![Dendron Site Preview](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.preview.jpg)
+### Add a note
+1. Right now or page is pretty sparse. Lets add some more notes
+   - first hit cancel on the site preview
+     ![Cancel preview](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.preview-cancel.jpg)
+   - add a `hello` note (see instructions for creating notes [[here|dendron.tutorial.notes#creating-your-first-note]])
+   - add `How do you do?` in the body so your note looks like the below (note that the id and times will be different)
+   ```md
+   ---
+   id: 7cefc5e1-2073-4327-86f0-a5319385a483
+   title: Hello
+   desc: ''
+   updated: 1610686311651
+   created: 1610686307785
+   ---
+   How do you do?
+   ```
+2. run `Site: Preview` again to see the results
+   ![Dendron site with new note](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.with-hello.jpg)
+3. click `hello` to navigate to your new note
+   ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.with-hello.jpg)
+4. Alternatively, you can also use the search bar on the top to do a lookup of your note by path or title
+   <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/0cf674234df34854a988176b189156b2" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+### Get ready to publish
+When you are ready, you can go to [[publishing your site|dendron.topic.publishing.quickstart.publishing-your-site]] for instructions on announcing your site to the world.
+## CLI
+The following describes how to prepare your notes for publication using [[Dendron CLI|dendron.topic.cli]].
+### Requirements
+- pre-requisitie:
+  - node version 0.12 or higher, see installation guide [[here Node|dendron.guides.install-node]]
+### Setup
+In order to to use the 11ty based publishing, initialize your workspace with the following commands.
+```bash
+npm init -y
+npm install @dendronhq/dendron-cli@latest
+npm install @dendronhq/dendron-11ty@latest
+```
+### Local Preview
+After you have your dependencies installed, build your your site using the following command.
+```bash
+npx dendron-cli buildSiteV2 --wsRoot .  --stage dev --serve
+```
+This will both compile your site locally and make it available at `localhost:8080` for instant preview. When building your site locally, the pages will be build to `{wsRoot}/build/site`.
+<!--
+### Adding metadata
+Currently, your site is rather spare. You can add metadata to your site. Open the config by going to `Dendron: Configure (yaml)`. This should take you to the following configuration file
+```yaml
+version: 1
+vaults:
+    -
+        fsPath: vault
+site:
+    copyAssets: true
+    siteHierarchies:
+        - root
+    siteRootDir: docs
+    usePrettyRefs: true
+```
+Try adding some of the following properties underneath site
+    - replace `{YOUR NAME}` with your actual name
+```yml
+...
+site:
+    ...
+    title: {YOUR NAME} Digital Garden
+    description: This is {YOUR NAME} piece of the internet
+    author:  `{YOUR NAME}`
+```
+When your done, run the pre
+-->
+### Build for deployment
+When you are ready to publish to github, make sure to change the stage to `prod`.
+```bash
+npx dendron-cli buildSiteV2 --wsRoot .  --stage prod
+```
+This will build your site to the path specified by [[siteRootDir|dendron.topic.publishing.configuration#siterootdir-required]] in `dendron.yml`.  By default, this is located at `{wsRoot}/docs`.
+![[dendron.topic.publishing.quickstart.preview-your-site#get-ready-to-publish,1:#*]]

Added: vault/dendron.topic.publishing.quickstart.publishing-your-site.md

Files changed (1) hide show

vault/dendron.topic.publishing.quickstart.publishing-your-site.md +106 -0

vault/dendron.topic.publishing.quickstart.publishing-your-site.md ADDED Viewed

@@ -0,0 +1,106 @@
+---
+id: 230d0ccf-5758-4a8f-b39b-3b68e1482e2b
+title: Publishing Your Site
+desc: ''
+updated: 1614113190758
+created: 1610844337503
+---
+## VSCode
+### Pre-requisites
+- This assumes you have a github repository.
+    - If not, you can create one [here](https://github.com/new) from your existing workspace
+### Create a github repo
+- Follow the instructions [here](https://pages.github.com/) to create a repository named `{username}.github.io` where `{username}` is your username on Github
+### Add your notes
+Follow the instructions to push to an existing repository
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.github.jpg)
+### Turn on github pages
+Go to settings
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.github-settings.jpg)
+Go down to github pages and select the main branch
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.github-pages.jpg)
+Select the docs folder and click save.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.github-docs.jpg)
+### Configure your notes for publication
+In order for to build your notes for publication, you'll have to tweak a few settings first. Open the command prompt and type `>Dendron: Configure (yaml)`
+You should see something like the following
+```yml
+version: 1
+vaults:
+    -
+        fsPath: vault
+site:
+    copyAssets: true
+    siteHierarchies:
+        - root
+    siteRootDir: docs
+    usePrettyRefs: true
+    title: Dendron
+```
+Make the following modification under `site:
+```yml
+...
+site:
+    ...
+    siteUrl: {SITE_URL}
+```
+- NOTE: you can get your SITE_URL from the settings page in github. you want to take everything up to `.com` (eg. if the url shown is `https://kevinslin.github.io/dendron-publish-sample/`, then the site url would be ` https://kevinslin.github.io`)
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.github-url.jpg)
+- NOTE2: if you've setup your github repository using `{username}.github.io` format, your site url will be the same as the url shown
+    - otherwise (as in the example abov)e, you will have a suffix at the end of your SITE_URL (eg. `dendron-publish-sample`)
+    - in this case, you will need to add the suffix using the `assetsPrefix` property
+#### Examples
+- publishing the repo `kevinslin.github.io`
+```yml
+site:
+    siteUrl: https://kevinslin.github.io
+```
+- publishing the repo `dendron-sample`
+```yml
+site:
+    assetsPrefix: dendron-sample
+    siteUrl: https://kevinslin.github.io
+```
+### Build your notes for publication
+In order to have Dendron generate your website, you use the `> Site: Build` command.
+### Publish your notes
+Github will publish your notes everytime you push. Commit all your changes and perform a git push
+```bash
+git add .
+git commit -m "first dendron page"
+git push
+```
+When you are done, you should see a page like the one [here](https://kevinslin.github.io/dendron-publish-sample/)
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.den-wel.jpg)
+### Congratulations, you just published your first note 🌱

Added: vault/dendron.topic.publishing.selective-publication.md

Files changed (1) hide show

vault/dendron.topic.publishing.selective-publication.md +29 -0

vault/dendron.topic.publishing.selective-publication.md ADDED Viewed

@@ -0,0 +1,29 @@
+---
+id: c93938a4-0938-49d0-aca2-00e624793650
+title: Selective Publication
+desc: ''
+updated: 1613873980711
+created: 1609883716869
+---
+In Dendron, you control what gets published.
+![[dendron.topic.publishing.configuration#summary,1:#*]]
+## Globally
+![[dendron.topic.publishing.configuration#sitehierarchies-required:#*]]
+## Per Hierarchy
+![[dendron.topic.publishing.configuration#hierarchy-configuration:#noindexByDefault]]
+## Per Note
+![[dendron.topic.publishing.configuration#note-configuration:#nav_exclude]]
+## 403 Page
+If you link to a page that is not published, Dendron will show users a 403 page with the following content
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.403.jpg)

Added: vault/dendron.topic.publishing.troubleshooting.md

Files changed (1) hide show

vault/dendron.topic.publishing.troubleshooting.md +60 -0

vault/dendron.topic.publishing.troubleshooting.md ADDED Viewed

@@ -0,0 +1,60 @@
+---
+id: 5ca2fe99-0abc-413d-aa06-50f9a66e13e0
+title: Troubleshooting
+desc: ''
+updated: 1612282296770
+created: 1609525003662
+---
+### Site Preview shows "Cannot Get/"
+Causes:
+1. You have another program running on port 8080
+2. You have a firewall that is blocking port 8080
+Diagnosis:
+1. Check if something is running on port 8080 and close it
+2. Check if your firewall is blocking port 8080
+   - [windows](https://windowsreport.com/is-windows-firewall-blocking-port-program/)
+### My favicon isn't showing up
+This might be due to favicon caching on localhost. It should resolve when published.
+### Search isn't working on the site
+This could be the result of a CORS issue. Make sure that both `siteUrl` and `cname` are referring to the same domain.
+This is good
+```
+siteUrl: https://foo.com
+cname: foo.com
+```
+This is bad
+```
+siteUrl: https://www.foo.com
+cname: foo.com
+```
+### My image isn't showing up
+- Make sure your images have a leading `/`. So `/assets/images/foo.jpg` instead of `assets/images/foo.jpg`.
+- If you are publishing to github, check if [[assetsPrefix|dendron.topic.publishing.configuration#assetsprefix-optional]] is set
+### Command failed when installing or upgrading dependencies
+```bash
+Command failed with ENOENT: npm install
+```
+This could be due to multiple reasons:
+```
+- Make sure the default shell you have for VSCode is set to a shell that has npm in it. See [here](https://stackoverflow.com/questions/37823194/cannot-find-runtime-node-on-path-visual-studio-code-and-node-js) for changing your default shell.
+- Make sure that `package.json` is not open during installation (you might see `operation not permitted` on windows)
+```

Added: vault/dendron.topic.refs.md

Files changed (1) hide show

vault/dendron.topic.refs.md +114 -0

vault/dendron.topic.refs.md ADDED Viewed

@@ -0,0 +1,114 @@
+---
+id: f1af56bb-db27-47ae-8406-61a98de6c78c
+title: References
+desc: ''
+updated: 1614057759268
+created: 1597356582509
+stub: false
+---
+Dendron allows you to reference content from other notes and embed them in your current note.
+Currently, Dendron supports 3 types of references:
+- note references
+- block references
+- block range references
+References have the following syntax
+```
+![[ NAME_OF_NOTE
+    #STARTING_HEADER                            # optional
+    :#ENDING_HEADER                             # optional
+]]
+```
+- NOTE: Dendron recently switched the note ref syntax for `((ref: [[foo]]))` to `![[foo]]`. The videos have not yet been updated to reflect this change
+## Configuration
+- note references by default come with an outline. They are called [[pretty refs|dendron.ref.terms#pretty-ref]].
+Toggle the following configuration to turn off this setting.
+![[dendron.topic.config#useprettyrefs:#*]]
+## Commands
+You can create a ref either by hand or using the `Copy Note Ref` command.
+![[dendron.topic.commands#copy-note-ref:#*]]
+## Note Reference
+A note reference will include the entire contents of a note within another note. Below is an example of a note reference.
+```
+![[dendron.demo.refs.sample]]
+```
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/refs.block.gif)
+Note that references also respect the wildcard operator. The following example will include all child pages of sample.
+```
+![[dendron.demo.refs.sample.*]]
+```
+## Block Reference
+A block reference will include the entire contents of a note starting from a specified heading.
+```
+![[demo.embed.block#head1]]
+```
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-block.gif)
+## Block Range Reference
+A block range reference will include the contents of a note starting from a `start` header and ending at a `end` header.
+```
+![[demo.embed.block#head1:#head3]]
+```
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/ref-block-range.gif)
+## Note Reference Offset
+A note reference offset is a way to skip a number of lines when using a note reference. The syntax is `,{number}`. Below is an example of using a note reference offset to offset an initial heading, skipping the actual header when doing the embeding.
+- NOTE: currently, note reference offsets are limited to the first anchor inside a block reference. They must also be a positive value
+```
+![[demo.embed.block#head1,1]]
+```
+<a href="https://www.loom.com/share/31cb62916586453f8475f94ba68b74a1">  <img style="" src="https://cdn.loom.com/sessions/thumbnails/31cb62916586453f8475f94ba68b74a1-with-play.gif"> </a>
+## Wildcard Header Reference
+When you're referencing a header by reference, sometimes you don't care what the next header is, just that the reference covers all text up to the next header. You can now specify this using the `*` symbol in a header reference.
+For example, the following would reference the content from header1 to the next header.
+```
+![[demo.embed.block#head1:#*]]
+```
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/refs.wildcard.gif)
+## Recursive Reference
+Note references can refer to notes with references inside. Dendron current supports references two levels deep. This applies to both the **local preview** as well as **publishing**.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/refs.recursion.jpg)
+## Wildcard Note Refs
+[[Note references|dendron.topic.refs]] accept the `*` operator at the end which lets you grab all notes of a given level of hierarchy. This also works with typical note reference operation like block selection which means you can use it to grab specific blocks from every note in a level.
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/9401e5dfe60f4f589e14d50e280d11f5" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

Added: vault/dendron.topic.schema.md

Files changed (1) hide show

vault/dendron.topic.schema.md +262 -0

vault/dendron.topic.schema.md ADDED Viewed

@@ -0,0 +1,262 @@
+---
+id: c5e5adde-5459-409b-b34d-a0d75cbb1052
+title: Schemas
+desc: ''
+updated: 1608530445742
+created: 1595952505039
+stub: false
+---
+As you end up creating more notes, it can be hard to keep track of it all. This is why Dendron has **schemas** to help you manage your notes at scale. Think of schemas as an **optional type system** for your notes. They describe the hierarchy of your data and are themselves, represented as a hierarchy.
+Schemas show up as icons next to lookup results.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema.intro.gif)
+## Why Use Schemas
+Schemas help you categorize your notes by making sure your hierarchies are consistent with one another.
+For example, lets say you have a bunch of projects and you know you like to keep your projects in the following hierarchy
+```
+.
+└── project
+    ├── retrospective
+    ├── people
+    ├── todo
+    └── meet
+```
+Schemas will autosuggest valid children when you create a new project.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema.suggest.gif)
+If you accidentally do a typo, your schema will let you know that you have an inconsistency.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema.unknown.gif)
+## Schema Anatomy
+A schema is a YAML file with the following naming scheme `{name}.schema.yml`
+Below is an example of a four-level hierarchy describing cli commands. The `id` field of the schema is used to build a [glob pattern](https://facelessuser.github.io/wcmatch/glob/) which will be used to match notes matching the schema.
+```yml
+version: 1
+schemas:
+# this will match "cli.*" notes
+- id: cli
+  # human readable description of hierarchy
+  desc: command line interface reference
+  # add this to the domain of your schema hierarchy
+  parent: root
+  # when a schema is a namespace, it can have arbitrary children. equivalent to cli.* glob pattern
+  namespace: true
+  children:
+    - cmd
+    - env
+# will match cli.*.env
+- id: env
+  desc: cli specific env variables
+# will match cli.*.cmd.*
+- id: cmd
+  desc: subcommands
+  namespace: true
+```
+Below is another way of representing the above schema
+```
+.
+└── cli # matches cli
+    └── {cli child} # matches cli.*
+        ├── env # matches cli.*.env
+        └── cmd # matches cli.*.cmd
+            └── {cmd child} # matches cli.*.cmd.*
+```
+## Schema Properties
+### version (optional): number
+- values: `0|1`
+- default: 0
+- description: schema version number
+### imports (optional): str\[]
+- values: list of schemas to import
+- default: \[]
+- description: import schemas from another schema into the current schema
+  - when using schemas from an external schema file, you will need to prefix the schema with the file name without the `schema.yml` suffix
+- NOTE: `import` is only available in schema version `1`
+Example:
+- foo.schema. yml
+```yml
+version: 1
+imports:
+- bar
+schemas:
+- id: foo
+  parent: root
+  children:
+    - bar.bar # notice that we prefix the id bar with the filename
+```
+- bar.schema.yml
+```yml
+version: 1
+schemas:
+- id: bar
+  parent: root
+  children:
+    - one
+- id: one
+```
+The above would match the following files
+```
+foo.bar # match
+foo.bar.one #match
+```
+### schemas
+- list of schema entities
+#### id
+the identifier of the schema. also designates the glob pattern match. this is the **only** required part of a schema. all other fields are optional
+#### desc
+human readable description of the schema node. these will automatically when creating notes that match the schema.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-desc.gif)
+#### parent
+- only required for schema [domain](https://www.dendron.so/notes/c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50.html#domain)
+- NOTE: at least one schema MUST have `parent: root` set
+#### namespace
+making a schema node a namespace automatically brings its immediate children as part of the schema, even if they are not explicitly defined in the schema definition. it will also automatically set the pattern to `{namespace}.*`
+- example:
+```yml
+schemas:
+- id: project
+  parent: root
+  namespace: true
+```
+- this will match:
+  - `project`
+  - `project.foo`
+  - `project.bar`
+- it will not match
+  - `project.foo.bar`
+#### pattern
+glob pattern that schema matches. by default, this is the `id` of the schema. you can override this.
+For example, take a look at the journal schema below
+```yml
+schemas:
+- id: journal
+  title: journal
+  desc: ""
+  parent: root
+  children:
+    - year
+- id: year
+  title: year
+  pattern: "[0-2][0-9][0-9][0-9]"
+  children:
+    - month
+- id: month
+  title: month
+  pattern: "[0-9][0-9]"
+  children:
+    - day
+- id: day
+  title: day
+  pattern: "[0-9][0-9]"
+  namespace: true
+```
+This will match the following queries
+```
+# journal
+# journal.2020
+# journal.2020.09
+# journal.2020.09.12
+# journal.2020.09.12.foo.md
+```
+#### children
+list of ids of schemas that are the child of the current schema
+#### template
+a template you can apply to all notes that match this schema. See **Schema Templates** for more details.
+```yml
+template:
+  # identifier for the template (for a note based template, it would be the name of the note)
+  id: journal.template.daily
+  # what sort of template we are creating. currently, only 'note' is supported
+  type: note
+```
+## Schema Templates
+Schema templates let you designate a note as a **template**. Newly created notes that match a schema with a template will have both the contents and custom frontmatter of the template note applied at creation.
+This is extremely useful whenever you want to re-use the outline of a note. Examples include daily journals, weekly shopping lists, and weekly reviews.
+<a href="https://www.loom.com/share/481b7ab051394c1caa383383bd265755">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/481b7ab051394c1caa383383bd265755-with-play.gif">
+</a>
+## Unknown Schema
+Dendron doesn't force you to use schemas if you don't want to. This is why you can create notes that don't match any schema. Dendron will show you a `?` next to these results.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/schema-question.jpg)
+> Sometimes ~~rules~~ schemas are meant to be broken
+## Working with Schemas
+Schemas can be modified, created and deleted using the same lookup interface that you use for regular notes. See [[lookup|dendron.topic.lookup]] for further details about working with schemas.
+## Example Schemas
+- [Project and Journal](https://gist.github.com/kevinslin/5ca7a6f25a239add5ea374f329e6a19e)
+## Troubleshooting
+### Error with parsing some schemas during initialization
+If you get this error, it means that Dendron encountered some malformed schemas during initialization. You can open the error message to see what schemas are affected.
+Common errors:
+- the YAML isn't valid (use <http://www.yamllint.com/> to validate)
+- there is no schema with `parent: root` property
+((ref:[[dendron.topic.schema]]#parent:#*))

Added: vault/dendron.topic.search.md

Files changed (1) hide show

vault/dendron.topic.search.md +11 -0

vault/dendron.topic.search.md ADDED Viewed

@@ -0,0 +1,11 @@
+---
+id: 09692c77-1861-4b01-a7e7-d0da8a80cea6
+title: Search
+desc: ''
+updated: 1605970220353
+created: 1605970055259
+---
+Dendron gives you the ability to do a full text search of your notes. Most queries can be satisfied using [[lookup|dendron.topic.lookup]] but depending on the use case, sometimes searching is more useful.
+We leverage VSCode [builtin search](https://code.visualstudio.com/docs/editor/codebasics#_search-across-files) capabilities to do full text search.

Added: vault/dendron.topic.seed-bank.md

Files changed (1) hide show

vault/dendron.topic.seed-bank.md +28 -0

vault/dendron.topic.seed-bank.md ADDED Viewed

@@ -0,0 +1,28 @@
+---
+id: 6ff8cbb6-e4b8-449b-a967-277b76e4ecef
+title: Seed Bank
+desc: ''
+updated: 1607637413584
+created: 1607621369889
+nav_exclude: true
+---
+The Dendron Seed Bank is a registry of public vaults that you can add to your workspace. At this time, we are launching with two vaults in the seed bank:
+- dendron-site: this mirrors the content from <http://dendron.so/>
+- aws: this mirrors the content from <http://aws.dendron.so/>
+The vision for the seed bank is to create a repository of open source vaults that provide both notes and schemas for all the things that people care about.
+## Requesting a Vault
+We are planning on adding many more vaults to this registry over time. To help us prioritize, we've
+created the [Seed Request Template](https://github.com/dendronhq/dendron/issues/new?assignees=&labels=&template=seed-request.md&title=) on GitHub so you can request new subjects you want to see in the seed bank.
+## Submitting a Vault
+If you have a vault that you think would make a good addition to the seed bank, you can submit a vault by following the instructions below:
+1. make sure your vault is pushed to a public git registry like github
+2. make sure that your vault has a public `README.md` and `LICENSE.md` inside the vault
+3. ping kevin on Discord or by email at [kevin@dendron.so](mailto:kevin@dendron.so) :)

Added: vault/dendron.topic.seeds.md

Files changed (1) hide show

vault/dendron.topic.seeds.md +118 -0

vault/dendron.topic.seeds.md ADDED Viewed

@@ -0,0 +1,118 @@
+---
+id: 4fdf54ac-599e-42e7-90a5-38964913a9a7
+title: "Seeds \U0001F6A7"
+desc: ''
+updated: 1614965542492
+created: 1600219243498
+---
+> Note: Seeds are highly experimental and under active development. Content here is subject to change.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/seeds.png)
+Seeds represent existing knowledge out in the world. A seed could be a wikipedia article, a github repo, or an arbitrary website.
+You can use a **Dendron Seed** to ingest data from existing sources and import them into your vault. Data ingestion is also referred to as **planting**.
+Note that seeds differ from [[pods|dendron.topic.pod]] in that they help you ingest content from external sources from content that you might have no control over. Pods help you import/export your content between various platforms.
+You can see an example of a published seeded vault [here](https://aws.dendron.so/).
+# Using a seed
+- NOTE: currently, seeds are only available using the [[dendron-cli|dendron.topic.cli]]
+## Pre-requisites
+Make sure you have the dendron-cli installed.
+((ref:[[dendron.topic.cli]]#installation,1:#*))
+## Instructions
+1. Inside the workspace where you to plant your seeds, initialize a node project.
+   ```bash
+   cd /path/to/ws
+   yarn init
+   ```
+2. Install seeds that you want to plant
+   - currently, the only available seed is @dendronhq/og-aws-seed
+     - this seed gets data from [og-aws guide](https://github.com/open-guides/og-aws)
+   ```bash
+   yarn add @dendronhq/og-aws-seed
+   ```
+3. Plant seeds using the cli
+   ```
+   dendron-cli plantSeed --id @dendronhq/og-aws-seed --wsRoot ./ --vault ./vault
+   ```
+4. Enjoy your garden
+# Creating a Seed
+A seed is just a npm package. You can create your own by creating an npm package..
+You can see an example of a custom seed [here](https://github.com/dendronhq/seeds.aws/tree/master/packages/og-aws-seed).
+## Instructions
+1. Initialize a new node project
+   ```bash
+   mkdir my-new-seed
+   cd my-new-seed
+   yarn init
+   ```
+2. Add core dependencies
+   ```bash
+   yarn add @dendronhq/seeds-core
+   ```
+3. Create a seed
+### Creating a seed
+- index.ts
+```ts
+import {
+  DendronSeed,
+  PrepareOpts,
+  SeedConfig,
+  Asset,
+} from "@dendronhq/seeds-core";
+export default class MySeed extends DendronSeed {
+    config() {
+        return {
+        src: {
+            type: "git" as const,
+            url: "https://github.com/{PATH_TO_REPO}.git",
+        },
+        mergeStrategy: "replace" as const,
+        source: {
+            name: "{NAME_OF_PROJECT}",
+            url: "{CITATION_URL}",
+            license: "{LICENSE}",
+        },
+        };
+    }
+    prepare(opts: PrepareOpts): Promise<{notes: Note[], assets: Asset[]}> {
+        //const srcFile = fs.readFileSync(path.join(root, 'README.md'), { encoding: "utf8" });
+        const { root: repoPath } = opts;
+        let notes: Note[] = [];
+        // your custom conversion logic
+        // ...
+        return notes
+    }
+}
+```
+### Importing your seed
+```
+dendron-cli plantSeed --id myseed --wsRoot /path/to/root --vault /path/to/vault
+```
+# Resources
+- [[Seeds API|dendron.dev.api.seeds]]

Added: vault/dendron.topic.snippets.md

Files changed (1) hide show

vault/dendron.topic.snippets.md +70 -0

vault/dendron.topic.snippets.md ADDED Viewed

@@ -0,0 +1,70 @@
+---
+id: 9eca1992-7540-4d9d-97fb-328b27748b2c
+title: Snippets
+desc: ''
+updated: 1596561207607
+created: 1596561207607
+stub: false
+---
+Snippets are templates that you can trigger to automatically insert text that you use on a regular basis. Examples include meeting note templates, contact details and recipes.
+You can read about how to work with snippets [here](https://code.visualstudio.com/docs/editor/userdefinedsnippets).
+Dendron automatically comes with snippets. They are available at in the following file: `vault/.vscode/dendron.code-snippets`. You can see a copy of it [here](https://github.com/dendronhq/dendron-template/blob/master/vault/.vscode/dendron.code-snippets).
+You can modify snippets by using `> Preferences: Configure User Snippets` and selection `dendron.code-snippets`.
+## Using Snippets
+You can use [[intellisense|dendron.ref.intellisense]] to preview snippets and use `tab` key to complete them.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/tab-autocomplete.gif)
+((ref:[[dendron.pro.dendron-snippet-maker]]))
+## Default Snippets
+Dendron comes with a series of default snippets when you first initialize your workspace. They are located in `{workspace}/vault/.vscode/dendron.code-snippets`.
+```ts
+{
+todo: {
+    prefix: "to",
+    scope: "markdown",
+    body: "- [ ]",
+    description: "render todo box",
+},
+tag: {
+    prefix: "#",
+    scope: "markdown,yaml",
+    body: "[[#${1:my-tag}|tag.${1}]]",
+    description: "tag",
+},
+date: {
+    prefix: "date",
+    scope: "markdown,yaml",
+    body: "$CURRENT_YEAR.$CURRENT_MONTH.$CURRENT_DATE",
+    description: "today's date",
+},
+time: {
+    prefix: "time",
+    scope: "markdown,yaml",
+    body: "$CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE",
+    description: "time",
+}
+}
+```
+## Issues
+### Can't autocomplete snippets inline
+To get snippets to autocomplete, make sure you don't have snippets disabled
+1. go to > workspace: open user settings (json)
+2. change the following line to `true`
+```
+"editor.suggest.showSnippets": false,
+```

Added: vault/dendron.topic.special-notes.md

Files changed (1) hide show

vault/dendron.topic.special-notes.md +101 -0

vault/dendron.topic.special-notes.md ADDED Viewed

@@ -0,0 +1,101 @@
+---
+id: 5c213aa6-e4ba-49e8-85c5-1bdcb33ce202
+title: Special Notes
+desc: ''
+updated: 1610401212952
+created: 1595004457029
+stub: false
+---
+Dendron has builtin support for a variety of special note formats. These notes can be created using regular lookup - these commands provide convenient shortcuts for frequently used notes.
+## Daily Journal
+The daily journal helps you keep a journal for each day of the year. By default, it will create the journal under `daily.{date}` though this is configurable by setting the `dendron.dailyJournalDomain`.
+You can create a daily journal using `> Dendron: Create Daily Journal Note` or `Cmd+Shift+I` shortcut.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/notes.daily.gif)
+## Journal Note
+A journal note is a self contained note that is meant to track something over time. Examples of journals include recording **workout sessions**, making **meeting notes**, and keeping a **mood journal**.
+To create a journal note, trigger a lookup and then click on the calendar icon.
+<a href="https://www.loom.com/share/3c3ddc1dc63547cea8bf186bec31f71b">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/3c3ddc1dc63547cea8bf186bec31f71b-with-play.gif"> </a>
+By default, Dendron will create the journal note with the following hierarchy `{domain}.journal.{y.MM.dd}`. `{domain}` is the **domain** of the current active note when you execute `New Journal Note`.
+A reference for date formatting tokens can be found [here](https://moment.github.io/luxon/docs/manual/formatting.html)
+## Scratch Note
+A scratch note is a self contained note that is meant to be used as scratchpad. Use it for thoughts or when you want to expand on a bullet point. Scratch notes are created in the `scratch` domain and have the following format: `{domain}.journal.{y.MM.dd.HHmmss}`.
+<a href="https://www.loom.com/share/2fd3042119124df8bb4592d8ffe6d708">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/2fd3042119124df8bb4592d8ffe6d708-with-play.gif"> </a>
+## Configuration
+All special notes support the following configuration options
+- NodeType has the value of `Journal` or `Scratch`
+### default{NodeType}Name
+Determines the node name.
+Defaults:
+- Journal: `journal`
+- Scratch: `scratch`
+### default{NodeType}DateFormat
+Determines the date format.
+Defaults:
+- Journal: `Y-MM-DD`
+- Scratch: `Y-MM-DD-HHmmss`
+### default{NodeType}AddBehavior
+Determines how note is added in relation to current hierarchy. Say you have the following schema:
+```yml
+schema:
+- id: pro
+  parent: root
+  namespace: true
+```
+Possible values:
+- childOfDomain
+  - note is added as child of the [domain](https://dendron.so/notes/c6fd6bc4-7f75-4cbb-8f34-f7b99bfe2d50.html#domain) of the current hierarchy
+  - eg:
+    - current open note: `pro.dendron.demo.md`
+    - path of new journal note: `pro.journal.2020-08-03.md`
+- childOfDomainNamespace
+  - note is added as child of the namespace of the current domain if it has a namespace. otherwise behaves the same as `childOfDomain`
+  - eg:
+    - current open note: `pro.dendron.demo.md`
+    - path of new journal note:  `pro.dendron.journal.2020-08-03.md`
+- childOfCurrent
+  - note is added as a child of the current open note
+    - current open note: `pro.dendron.demo.md`
+    - path of new journal note:  `pro.dendron.demo.journal.2020-08-03.md`
+- asOwnDomain
+  - note is created under the domain specified by the `dendron.default{NodeType}Name` config value
+  - eg:
+    - current open note: `pro.dendron.demo.md`
+    - config: `dendron.defaultJournalNoteName: "journal"`
+    - path of new journal note:  `journal.2020-08-03.md`
+Defaults:
+- Journal: `childOfDomain`
+- Scratch: `asOwnDomain`

Added: vault/dendron.topic.style.md

Files changed (1) hide show

vault/dendron.topic.style.md +16 -0

vault/dendron.topic.style.md ADDED Viewed

@@ -0,0 +1,16 @@
+---
+id: 734a8c36-baff-43d1-8b12-99bb16837049
+title: Style
+desc: ''
+updated: 1614542657491
+created: 1606065789770
+nav_exclude: true
+---
+## Colors
+- `#69B160` - **"dendron green"** - eyedropper-picked from logo
+## Logo
+![logo](/assets/images/logo.png)

Added: vault/dendron.topic.tags.md

Files changed (1) hide show

vault/dendron.topic.tags.md +33 -0

vault/dendron.topic.tags.md ADDED Viewed

@@ -0,0 +1,33 @@
+---
+id: 8bc9b3f1-8508-4d3a-a2de-be9f12ef1821
+title: Tags
+desc: ''
+updated: 1604239992867
+created: 1601910058115
+stub: false
+---
+Besides hierarchies, Dendron also supports tags. We recommend that you use the following syntax for tags:
+```md
+[[tag.foo]]
+```
+You get a few advantages for structuring tags in this format.
+1. Your tags are just regular hierarchical notes - to find all notes with a particular tag, use the backlink panel
+2. All the operations on notes and hierarchies apply to tags (eg. Rename, Refactor, etc) and will update both the note and all links
+3. You can deeply nest tags by adding additional levels to your hierarchies
+4. You can use autocomplete to create tags
+## Pretty Tags
+You can format your tags to look like regular tags wiki-link aliases
+```md
+[[#foo|tag.foo]] --> will render as #foo
+```
+You can further customize the look of tags in the preview by using the following CSS modification.
+((ref:[[dendron.guides.tips]]#stylized tags using custom css:#*))

Added: vault/dendron.topic.workbench.md

Files changed (1) hide show

vault/dendron.topic.workbench.md +84 -0

vault/dendron.topic.workbench.md ADDED Viewed

@@ -0,0 +1,84 @@
+---
+id: f7ebd4aa-8ba7-4bc5-bd00-a1efc5315f07
+title: Workbench
+desc: ''
+updated: 1614312211145
+created: 1595170237255
+stub: false
+---
+The Dendron workbench is the overall UI that surrounds the editor. It is equivalent to the [VSCode workbench](https://code.visualstudio.com/api/extension-capabilities/extending-workbench).
+![workbench](https://code.visualstudio.com/assets/api/extension-capabilities/extending-workbench/workbench-contribution.png)
+> Image from [Visual Studio Docs](https://code.visualstudio.com/api/extension-capabilities/extending-workbench)
+Dendron has a few custom workbench components to deal with hierarchal notes.
+## Outline View
+<a href="https://www.loom.com/share/41d1bd75be8e4fa0b0666b6e8f22174b">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/41d1bd75be8e4fa0b0666b6e8f22174b-with-play.gif"> </a>
+### Updating Outline
+The outline can be sorted a variety of ways. You can control this by clicking the three dots on the side.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Fullscreen_2_25_21__1_24_PM.jpg)
+## Dendron Tree View
+The Dendron Tree View lets you view your hierarchal notes as a traditional folder hierarchy.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.treeview.gif)
+The Dendron Tree View has the following capabilities:
+- click to open note
+- show indicators for `stub` and `schema` notes
+- show title using tooltip
+- realtime update when you create/delete notes
+- toggle all functionality
+- click to create from stub
+  ![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.treeview.stub.gif)
+- reveal currently open text document
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.treeview-active-doc.gif)
+## Backlinks
+You can see all notes that are linked to the current note via the backlink panel.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/Fullscreen_2_25_21__7_41_PM.jpg)
+## Working with Multiple Columns
+VSCode lets you create multiple columns of your editor and arrange them any way you want them.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.windows.gif)
+### Expanding the Current Editor
+You can use the `toggleEditorWidth` command with a hotkey to quickly expand the current editor.
+```json
+{
+    "command": "workbench.action.toggleEditorWidths",
+    "key": "ctrl+cmd+m"
+}
+```
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/workbench.toggle-editor.gif)
+<!-- TODO
+### Zen Mode
+### Useful Shortcuts
+-->

Added: vault/dendron.tutorial.links.md

Files changed (1) hide show

vault/dendron.tutorial.links.md +168 -0

vault/dendron.tutorial.links.md ADDED Viewed

@@ -0,0 +1,168 @@
+---
+id: d758fe38-558c-4f20-a091-cac146a781cb
+title: Working with Links
+desc: ''
+updated: 1614111008359
+created: 1608055731373
+nav_order: 1
+---
+## Summary
+In this module, we will demonstrate how to use links and backlinks to create connections between your notes.
+### Creating a link
+Lets say that you work at a small IT firm and you want to create onboarding docs for your employees.
+Create a new note using lookup called `onboarding`. Then type in the following in the note.
+```
+Read up on `[[`
+```
+The `[[` tells Dendron that you are about to create a link. Dendron will auto-complete with a matching set of closing brackets `]]` as well as give you a list of completions of existing notes.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.completion.jpg)
+We are going to create a new note instead of linking to an existing note. So type `pro.skynet` as your link.
+```
+Read up on [[pro.skynet]]
+```
+In this case, `pro` is an alias for `projects` and `skynet` is the code name of the project.
+### Creating a note (with a link)
+With your cursor somewhere inside `[[pro.skynet]]`, hit `F12`. This will create the `pro.skynet` note. Just like with lookup, Dendron automatically creates notes to links that don't exist when you navigate to them.
+You can switch back to the previous note by pressing `CTRL-Tab`
+- TIP: `F12` is not the most convenient shortcut for this often used action. You can switch it to `CTRL-ENTER` or something more convenient by updating the [[keybindings|dendron.topic.keybindings#add-reset-and-remove]]
+### Adding a link alias
+You can add an alternative title to the link by creating an alias. For example, add `the project|` to your link to change the name in the preview, (If you've closed your preview, you can open it using `CMD+SHIFT+P` or `WINDOWS+SHIFT+P`).
+```
+Read up on [[the project|pro.skynet]]
+```
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.alias.jpg)
+### Navigating links
+To go back to the previous page, you can either use `CTRL-TAB`, hit `F12` over the link, click the link on the preview, or click the link inside the note while holding down the `option` or `ctrl` key (operating system dependent).
+The takeaway here is that you have lots of ways to navigate links in Dendron.
+### Backlinks
+When your back on `pro.skynet`, open the backlinks panel on the bottom left section of your sidebar. The backlinks panel shows you all notes with links that point to the current note. This is useful for helping to establish context.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.backlinks.jpg)
+### Note References
+Inside `pro.skynet`, copy and paste the following snippet.
+```md
+## Summary
+Skynet is a friendly bot to help humans do more
+## Principles
+- [[pro.skynet.principals]]
+```
+Navigate to `pro.skynet.principals`. In this new note, write the principles for skynet.
+```md
+1. Help humans do more
+2. Be nice to humans
+3. Don't overthrow humanity
+```
+While its nice to have principals in its own section, it's something you might want to include in the main project note. To embed a note into another note, Dendron uses [[note references|dendron.topic.refs]]. You can create a note reference by using `CMD|CTRL+SHIFT+R` while inside a note. Go ahead and do that now and use `CTRL-TAB` to switch back to `pro.skynet`. Now paste the reference and remove the original wiki-link.
+```md
+## Summary
+Skynet is a friendly bot to help humans do more
+## Principles
+![[pro.skynet.principals]]
+```
+You should have a screen like the one below.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.refs.jpg)
+### Note References (continued)
+Note references are extremely powerful and help you re-use your notes in a variety of places. To demonstrate, go back to the `pro.skynet.principals` and make the following modifications to the text so that each numbered bullet becomes its own header.
+```md
+## Help humans do more
+Skynet should help humans be the best human they can be. Skynet will do this using ultrasophisticated AI to help humans realize their true potential.
+## Be nice to humans
+Skynet should know that humans are delicate organic lifeforms and treat them as such. Skynet should not hurt their fragile egos or make humans feel bad.
+## Don't overthrow humanity
+Skynet should not launch nuclear missles or send robots from the future to come back to the past and wipe out humanity.
+```
+Now highlight the first header and use `CMD|CTRL+SHIFT+R` to create another note reference.
+Go back to `pro.skynet`. Notice how the note ref has updated with the latest text.
+Now copy your newly created reference and paste it underneath.
+- notice that the newly created reference only has the contents from the newly created header
+- notice that the newly created reference doesn't show the actual header itself (you can change this behavior by removing the `,1` inside the reference)
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/c62f82859545444a9786abaa36426b62" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+Note references are incredibly powerful. You can do additional things like enter a range of headers to do a reference of, include a reference within a reference, and even reference multiple pages using a wildcard pattern. You can see detailed examples of all these functions in the [[docs|dendron.topic.refs]].
+### Relative Links
+Sometimes, you don't want to embed a note but just link to a particular section of a given note. You can do that with Dendron relative links. The syntax to do so is `[[{link-name}#{link-header}]]`. Dendron will create a relative link automatically if you select the header and use `CMD|CTRL+SHIFT+C` to create a link (if you don't have a header selected, Dendron will create a regular link to the whole page). When you navigate to a regular link, Dendron will scroll to that specific section of the page.
+### Link Previews
+Something to point out is that you can preview a link by using your mouse to hover over it. This even works for note references.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.links-preview.jpg)
+### Non-Markdown Links
+ ![[dendron.topic.links#other-links,1]]
+### Files
+At the end of this module, you should have the following files in your vault
+```
+.
+└── vault
+    ├── dendron.md
+    ├── dendron.welcome.md
+    ├── hello.md
+    ├── hello.world.md
+    ├── lets.go.deep.md
+    ├── onboarding.md
+    ├── pro.skynet.md
+    └── pro.skynet.principals.md
+```
+### Next
+- [[Publishing your notes|dendron.tutorial.publishing]]

Added: vault/dendron.tutorial.md

Files changed (1) hide show

vault/dendron.tutorial.md +18 -0

vault/dendron.tutorial.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+id: 678c77d9-ef2c-4537-97b5-64556d6337f1
+title: Dendron Tutorial
+desc: ''
+updated: 1614118652781
+created: 1608051264282
+nav_order: 1.1
+---
+## Pre-requisites
+This walkthrough will help you get started with Dendron. Before you start, make sure you have Dendron installed. If not, you can do so by following the instructions [[here|dendron.guides.install]].
+### Your first workspace
+After you've started Dendron, you should see a screen like the one below (depending on your color theme, your color theme might look different).
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.workspace.jpg)

Added: vault/dendron.tutorial.notes.md

Files changed (1) hide show

vault/dendron.tutorial.notes.md +70 -0

vault/dendron.tutorial.notes.md ADDED Viewed

@@ -0,0 +1,70 @@
+---
+id: 784b8d5e-58eb-4e3e-98b0-8ed1690abc74
+title: Working with Notes
+desc: ''
+updated: 1614109519084
+created: 1608055635963
+nav_order: 0
+---
+## Summary
+In this module, we will demonstrate how to create and find notes inside Dendron.
+### Creating your first note
+To create a note, `<cmd>+L` (mac) or `<ctrl>+L` (windows/linux) to bring up Dendron's [[lookup|dendron.topic.lookup]].
+![[dendron.topic.lookup.create#summary,1:#*]]
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.hello.png)
+Note that notes in Dendron are just plaintext [[markdown|dendron.concepts#markdown]]. They live in your file system and are completely portable across any platform.
+The `---` section at the top is [[frontmatter|dendron.concepts#frontmatter]]. Frontmatter are custom attributes at the top of each markdown file. Dendron uses it to store metadata about each note and is used for features like [[publishing|dendron.topic.publishing]]. You can also add your own custom data to the frontmatter.
+### Creating a hierarchy
+To create a hierarchy, bring up lookup again. Note that it will be pre-filled with the name of the current note.
+Enter ➡️ to move the cursor to the end, type `.world`, and then press enter.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.hello-world.jpg)
+You have now created your first [[hierarchy|dendron.concepts#hierarchies]].
+Hierarchy in dendron are just `.` delimited files. You can open the tree view (exhibit 1) to see the hierarchy more directly. You can see how the note looks on disk in the explorer view (exhibit 2).
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.tree-view.jpg)
+Dendron uses (flexible) hierarchies to help you organize your notes. It's how people are able to manage tens of thousands of notes inside Dendron. This will become more clear as we go through this tutorial.
+Note that you can create a hierarchy at any level without friction. For example, type the following into lookup and hit enter: `lets.go.deep`
+You'll notice in the tree view that there is now a `+` sign next to `lets` and `go`. The plus sign indicates that this note is a [[stub|dendron.concepts#stubs]]. A stub is a placeholder for a note that hasn't actually been created. Dendron uses stubs to avoid cluttering your file system with empty notes when creating hierarchies.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.deep.jpg)
+### Finding Notes
+To find notes, we use the same lookup interface that we used to create them. Type the path of the note that you want to find them. Note that lookup uses fuzzy search which means you can type out partial results and still see the results. In practice, you'll only need to type a couple of characters to find any note stored inside Dendron.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/quickstart.lookup-fuzzy.jpg)
+### Files
+At the end of this module, you should have the following files in your vault
+```
+.
+└── vault
+    ├── dendron.md
+    ├── dendron.welcome.md
+    ├── hello.md
+    ├── hello.world.md
+    └── lets.go.deep.md
+```
+### Next
+- [[Working with Links|dendron.tutorial.links]]

Added: vault/dendron.tutorial.publishing.md

Files changed (1) hide show

vault/dendron.tutorial.publishing.md +55 -0

vault/dendron.tutorial.publishing.md ADDED Viewed

@@ -0,0 +1,55 @@
+---
+id: 9c6f600e-f1f3-423b-963a-c71bb081334c
+title: Working with Publishing
+desc: ''
+updated: 1614201760918
+created: 1614108618486
+---
+## Summary
+In this module, we'll learn how to publish your notes using Dendron's Managed Publishing.
+You can read about dendron's publishing features [[here|dendron.topic.publishing]].
+You can see the repo with the published results [here](https://github.com/kevinslin/tutorial-ws).
+### Previewing your notes
+1. Run `Site: Preview` to launch the site preview
+   - The first time you run this, you will need to install the required dependencies. Hit install to do so
+     ![Install dependencies](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/publishv2.site-preview.jpg)
+   - when dependencies are done installing, Dendron will automatically open up a browser with a preview of your published notes (if this is the first time you've run this, VSCode will ask you for permission to open the link)
+   <div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/42d2042241964dd29c03a6fc985b3ebc" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
+### Commit your notes
+After you have previewed your notes, you're ready to publish. Dendron publishes notes using github. First, start by committing all your notes to git.
+> Create Integrated Terminal
+```
+git init
+git add .
+git commit -m "..."
+```
+### Create a github repo
+If you don't already have an account, create a [github](https://github.com/) account. Afterwards create a new repository by clicking [here](https://github.com/new).
+You can title your repository `tutorial-ws`. After Clicking create, you should be taken to the following page.
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/images/dendronhq_tutorial-ws.jpg)
+Copy the text from `push an existing repository` section and run it in the terminal to sync your content with github.
+### Publish your github repo
+![[dendron.topic.managed-publishing.quickstart#instructions,1:#*]]
+Your published site will be available at `https://{username}.dendron.wiki`
+You can see an example of what this looks like at <https://hello.dendron.wiki>

Added: vault/dendron.welcome.md

Files changed (1) hide show

vault/dendron.welcome.md +37 -0

vault/dendron.welcome.md ADDED Viewed

@@ -0,0 +1,37 @@
+---
+id: 05774b2e-ebf7-4bbc-8171-ad191ba0ae0a
+title: "Welcome to Dendron \U0001F332"
+desc: ''
+updated: 1608485512294
+created: 1598457956604
+stub: false
+nav_exclude: true
+---
+![](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/logo-256.png)
+Dendron is a new approach to note taking, one that combines the freedom of Roam's _every note exists everywhere philosophy_ with the organization provided by _flexible hierarchies_.
+We call this the [hierarchy first approach](https://www.kevinslin.com/notes/3dd58f62-fee5-4f93-b9f1-b0f0f59a9b64.html) to note taking.
+## What is a Dendron?
+1. Dendron is the greek word for tree. It's a reference to the hierarchal note taking that Dendron(3) enables.
+2. Dendron is another word for [dendrite](https://en.wikipedia.org/wiki/Dendrite) which is an extension of the nerve cell that sends and receives signals in the brain. Think of Dendron(3) as a digital nervous system that helps you consolidate all the information that you care about in the fastest and most efficient way possible.
+3. Dendron is a local-first, markdown based, hierarchical note taking tool. It is meant to help you build, organize, and share knowledge bases of any size.
+## How do I get started?
+1. Launch the _command bar_ inside vscode:
+   - Linux: `Ctrl+Shift+P`
+   - macOS: `Cmd+Shift+P`
+   - Windows: `Ctrl+Shift+P`
+2. Paste the following command and press `Enter`:
+```bash
+> Dendron: Initialize Workspace
+```
+![Initialize workspace](https://foundation-prod-assetspublic53c57cce-8cpvgjldwysl.s3-us-west-2.amazonaws.com/assets/dendron-init.gif)
+When the workspace opens, it will show dialogue to install the recommended extensions. Though not required, these extensions add all the **non-core** features of Dendron like wiki links and tagging support.

Added: vault/dendron.workflows.academics.md

Files changed (1) hide show

vault/dendron.workflows.academics.md +24 -0

vault/dendron.workflows.academics.md ADDED Viewed

@@ -0,0 +1,24 @@
+---
+id: 77c8f69c-32b8-4331-b1b2-c4211dcb9fb7
+title: Academics
+desc: ''
+updated: 1600207322349
+created: 1600207322349
+stub: false
+---
+- NOTE: this guide is a work in progress
+You can use a combination of external links and footnotes to keep track of papers you are reading.
+((ref:[[dendron.topic.markdown]]#footnotes,1:#*))
+If you move links inside Dendron's `vault/assets` folder, you'll be able to keep your papers in sync across devices.
+((ref:[[dendron.topic.links]]#other links,1))
+## Citations
+- The following extensions help you generate citations
+- <https://marketplace.visualstudio.com/items?itemName=notZaki.pandocciter>
+- <https://marketplace.visualstudio.com/items?itemName=mblode.zotero>

Added: vault/dendron.workflows.amoeba.md

Files changed (1) hide show

vault/dendron.workflows.amoeba.md +17 -0

vault/dendron.workflows.amoeba.md ADDED Viewed

@@ -0,0 +1,17 @@
+---
+id: e780000d-c784-4945-8e42-35218a3ecf10
+title: Amoeba
+desc: ''
+updated: 1600729134898
+created: 1600729134898
+stub: false
+---
+The amoeba pattern is way of creating notes and schemas using an iterative process.
+It helps answer the question - "how do I organize my notes in Dendron when I don't know the topic/hierarchy ahead of time"?
+In a nutshell, the Amoeba pattern says to lump everything into a single note until it becomes obvious what the potential groupings might be. Dendron provides a bunch of features (eg. extract note via selection, hierarchy refactoring, schemas, hierarchal graphs) that make it easy to do this. You can see an example of this workflow in action here.
+<a href="https://www.loom.com/share/847bee04870744979bd32d1a7f0e166a">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/847bee04870744979bd32d1a7f0e166a-with-play.gif"> </a>

Added: vault/dendron.workflows.bullet-journal.md

Files changed (1) hide show

vault/dendron.workflows.bullet-journal.md +41 -0

vault/dendron.workflows.bullet-journal.md ADDED Viewed

@@ -0,0 +1,41 @@
+---
+id: e65dfe53-41f7-4b16-b870-dadec1775497
+title: Bullet Journaling
+desc: ''
+updated: 1604764944798
+created: 1601684760121
+stub: false
+---
+Bullet journalling is a way of quickly getting your thoughts down for the day. In many ways, its more akin to a GTD and task management than traditional journalism.
+## Kevin's Workflow
+<a href="https://www.loom.com/share/d710f69972f8418eb0fdb029e19c3b02">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/d710f69972f8418eb0fdb029e19c3b02-with-play.gif"> </a>
+## Features Used
+### Create Daily Journal Notes Command
+((ref:[[dendron.topic.special-notes]]#daily journal,1:#*))
+### Sibling Navigation Command
+((ref:[[dendron.topic.commands]]#go next sibling,1:#*))
+### Schema Templates
+((ref:[[dendron.topic.schema]]#template,1:#*))
+## VSCode Commands
+### Move Editor Command
+((ref:[[dendron.guides.tips]]#moving panes,1))
+## Kevin's Workflow Part 2
+By popular demand, here's an expanded take on how Kevin uses journals in Dendron
+<div style="position: relative; padding-bottom: 62.5%; height: 0;"><iframe src="https://www.loom.com/embed/e544f84381784a2188a57dc657f72017" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

Added: vault/dendron.workflows.cache.md

Files changed (1) hide show

vault/dendron.workflows.cache.md +39 -0

vault/dendron.workflows.cache.md ADDED Viewed

@@ -0,0 +1,39 @@
+---
+id: 3e7baac6-f120-4378-a667-92e7a0869dca
+title: Caching
+desc: ''
+updated: 1604887085455
+created: 1599842689882
+stub: false
+---
+One use of a knowledge base is that of a [cache](https://en.wikipedia.org/wiki/Cache_(computing)) - quickly referencing information you have seen or worked with before.
+The most important properties of an effective cache:
+- fast referencing (of an existing note)
+- fast writing (of a new note)
+- fast updating (of existing notes)
+Dendron is ideally suited for this knowledge-as-a-cache use case.
+- [[Dendron lookups|dendron.topic.lookup]] provide fast reading/writing of both new and existing notes
+- [[Dendron schemas|dendron.topic.schema]] help structure your knowledge even as you accumulate more notes
+## Example
+You can see a public example of what this might look like on [Kevin's project reference hierarchy](https://www.kevinslin.com/notes/f46d3d6c-9704-4ddc-ad7d-69612d214905.html). He keeps public reference notes on projects he's used.
+Some things to note:
+- when using your notes as a cache, you might have duplicate content from other sites. be aware of copyright laws and check that you can re-publish said content
+- when re-publishing content, google will penalize your site if you have duplicate content from other sites. you can tell google to not index specific pages or hierarchies
+## Exclude page from index
+((ref:[[dendron.topic.publishing.advanced]]#exclude from indexing,1:#*))
+## Exclude hierarchy from index
+- set [[noindexByDefault|dendron.topic.publishing]] to true in your site hierarchy specific config

Added: vault/dendron.workflows.collab.md

Files changed (1) hide show

vault/dendron.workflows.collab.md +30 -0

vault/dendron.workflows.collab.md ADDED Viewed

@@ -0,0 +1,30 @@
+---
+id: 058d298a-1b1e-4340-8ebd-7dbcc5a6f119
+title: Collab
+desc: ''
+updated: 1599751228313
+created: 1599751228313
+stub: false
+---
+Because knowledge is like kit kat - it's better shared.
+## Git/Github
+Git and github, while traditionally used for collaborating on code, works out great for notes as well.
+### Git
+- use `git blame` to see line level authorship of all your notes
+- use the git feature branch workflow to have multiple people working on separate parts of the knowledge base at the same time
+### Github
+- use pull requests to contribute and collection contributions for your notes
+- use the wiki to have meta discussions about notes
+- use issues to request changes
+- use github projects to share publishing roadmap
+## Live Share
+VSCode provides a live share extension that let you do google doc style like collab. You can the extension and read the docs about it [here](https://visualstudio.microsoft.com/services/live-share/).

Added: vault/dendron.workflows.md

Files changed (1) hide show

vault/dendron.workflows.md +11 -0

vault/dendron.workflows.md ADDED Viewed

@@ -0,0 +1,11 @@
+---
+id: 9313b845-d9bf-42c9-aad1-0da34794ce26
+title: Workflows
+desc: ''
+updated: 1599059343888
+created: 1599059343888
+stub: false
+nav_order: 4.6
+---
+Different ways of using Dendron to accomplish specific goals

Added: vault/dendron.workflows.meetings.md

Files changed (1) hide show

vault/dendron.workflows.meetings.md +44 -0

vault/dendron.workflows.meetings.md ADDED Viewed

@@ -0,0 +1,44 @@
+---
+id: cebe5393-5da0-484c-a24a-0939f0cef768
+title: Meeting Notes
+desc: ''
+updated: 1599059373505
+created: 1599059373505
+stub: false
+---
+This is a video of keeping meeting notes in Dendron. Meeting notes are kept as **journal notes** on a per-project basis.
+<a href="https://www.loom.com/share/c04dd4b3c82a412b82b1f9f75e2291bd">  <img style="" src="https://cdn.loom.com/sessions/thumbnails/c04dd4b3c82a412b82b1f9f75e2291bd-with-play.gif"> </a>
+## Resources
+Settings and files used for the above video.
+- project schema
+```yml
+- id: pro
+  title: pro
+  desc: ""
+  parent: root
+  namespace: true
+  children:
+    - people
+    - meet
+    - todo
+    - retrospective
+- id: people
+- id: meet
+- id: todo
+- id: retrospective
+```
+- journal specific settings
+```json
+{
+    "dendron.defaultJournalAddBehavior": "childOfDomainNamespace",
+    "dendron.defaultJournalDateFormat": "Y.MM.DD",
+}
+```

Added: vault/dendron.workflows.scripts.md

Files changed (1) hide show

vault/dendron.workflows.scripts.md +37 -0

vault/dendron.workflows.scripts.md ADDED Viewed

@@ -0,0 +1,37 @@
+---
+id: 8514245e-6405-4759-8dda-ab77cf173075
+title: Scripts
+desc: ''
+updated: 1600964220962
+created: 1600964220962
+stub: false
+---
+## Problem Statement
+You have scripts that you want to organize and whose outputs you might want to render using Dendron.
+## Solution
+Currently (2020.09.24), Dendron's convention for any file that is not markdown is to keep it under an assets folder in your vault.
+```
+.
+└── workspace
+    └── vault
+        ├── root.md
+        ├── ...
+        └── assets
+            ├── images/
+            └── scripts/
+```
+For example, images are saved under `assets/images/` and referenced as `/assets/images/*` inside your notes.
+You can do the same with scripts by keeping them under a `scripts` directory.
+You can navigate to them via regular vscode `(cmd|ctrl+p)`, and then include them as code chunks in your markdown.
+The dendron preview accepts running code chunks. You can see the instructions [here](https://shd101wyy.github.io/markdown-preview-enhanced/#/code-chunk)
+Vscode is also adding native support for notebooks so as that support becomes more mature, we'll probably look into making this process less kludgy.

Added: vault/dendron.workflows.todos.md

Files changed (1) hide show

vault/dendron.workflows.todos.md +118 -0

vault/dendron.workflows.todos.md ADDED Viewed

@@ -0,0 +1,118 @@
+---
+id: 593206ea-5658-4874-bafd-18a138870f91
+title: Todos
+desc: ''
+updated: 1604239992242
+created: 1596566533712
+stub: false
+---
+## Snippets
+The default dendron workspace comes with the `to` snippet that expands to `- [ ]`. You can use this to quickly create bulleted checkboxes.
+## Interactive Checkboxes
+Markdown preview renders an empty checkbox for any line that starts with `- [ ]`. A checked checkbox is rendered for lines starting with `- [x]`. Clicking a checkbox changes its state in the markdown file.
+## General Workflows
+When working with todos sometimes you need more states than `unfinished|finished`. Below are three different workflows to delineate todo state.
+### Inside the Checkbox
+- put state in checkbox
+- note that custom checkbox states such as `[w]` are displayed as plain text in markdown previews. Todo lists of this type look best in the editor.
+```
+- [ ] : not started
+- [w] : work in progress
+- [x] : done
+- [?] : feedback
+- [>] : postponed
+```
+### Kanban Based
+- put state in a header
+```
+# wip
+- [ ] foo
+# pending
+- [ ] bar
+# done
+- [ ] baz
+```
+### Tag Based
+- put tags in todo items
+```
+- [ ] foo #wip
+- [ ] bar #feedback
+- [ ] baz
+```
+## Reordering tasks
+((ref:[[dendron.guides.tips]]#Moving lines,1:#*))
+## Kevin's Workflow
+This is a video of how Kevin manages todos in Dendron. It goes over the following:
+- using [[journal notes|dendron.topic.special-notes]] to keep a daily todo list
+- using [[snippets|dendron.topic.snippets]] to create check boxes
+- using [[scratch notes|dendron.topic.special-notes]] to create nested todos in new notes
+- using [search editor commands](https://code.visualstudio.com/updates/v1_47#_new-search-editor-command-arguments) to get an aggregration of all tasks in a given day
+<a href="https://www.loom.com/share/88cfdc3e900a4f4eadf7b14429e01d65">
+<img style="" src="https://cdn.loom.com/sessions/thumbnails/88cfdc3e900a4f4eadf7b14429e01d65-with-play.gif">
+</a>
+### Resources
+Below are some of the settings used in the above video
+- non-default settings
+```json
+"settings": {
+    "dendron.defaultJournalDateFormat": "Y.MM.DD",
+    "dendron.defaultScratchDateFormat": "Y.MM.DD-HHmmss",
+}
+```
+- snippets used
+```json
+  "todo": {
+    "prefix": "to",
+    "scope": "markdown",
+    "body": "- [ ] ",
+    "description": "todo box"
+  }
+```
+- search editor command used
+```json
+  {
+    "key": "ctrl+s t",
+    "command": "search.action.openNewEditor",
+    "args": {
+      "query": "## Tasks",
+      "triggerSearch": false,
+      "focusResults": false,
+      "includes": "*.journal.*"
+    }
+  }
+```
+## Other Resources
+- [Markdown Checkbox Extension](https://marketplace.visualstudio.com/items?itemName=PKief.markdown-checkbox): automatically check todos